added license and readme

Author: prdx23

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - 2022 Arsh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,21 +2,21 @@
 
 Norite is a simple static website generator powered by [Jinja2](https://palletsprojects.com/p/jinja) as the templating engine.
 
-Norite's main goal is to act as an easy to use rendering engine for people who like to design their own templates or want to have the option of building a custom structure for their websites. To achive this goal norite exposes the entire content directory as a tree data-structure to the templates along with the rendered content, leaving it upto the template designer how to interpret and display this information.
+Norite's main goal is to act as an easy to use rendering engine for people who like to design their own templates or want to have the option of building a custom structure for their websites. To achieve this goal norite exposes the entire content directory as a tree data-structure to the templates along with the rendered content, leaving it up to the template designer how to interpret and display this information.
 
 Implemented Features:
 - Markdown to HTML render
 - Support for using toml or json files in place of markdown
 - Jinja2 based HTML templates
 - Support for embedding Jinja2 templates in markdown
-- Support for nested folders in website content 
+- Support for nested folders in website content
 - Support for custom templates for any subsection of the content folder
 - Support for co-locating assets with content
 - Syntax highlighting in code blocks
 - Sass compilation (via libsass or dart-sass)
-- In-built dev server with auto reload on file changes 
+- In-built dev server with auto reload on file changes
 - Support for building custom RSS/Atom feeds and robots.txt using templates
-- Automatic sitemap.mxl generation
+- Automatic sitemap.xml generation
 
 Todo:
 - Tests
@@ -35,17 +35,19 @@ pip install norite
 
 It will install the following additional packages: [jinja2](https://pypi.org/project/Jinja2/), [markdown](https://pypi.org/project/Markdown/), [toml](https://pypi.org/project/toml/), [pygments](https://pypi.org/project/Pygments/) and [watchdog](https://pypi.org/project/watchdog/).
 
-Alternatively, if you want to install it globally as a shell tool within an isolated python environment, install via [pipx](https://pypa.github.io/pipx/)
+Alternatively, if you want to install it globally as a shell tool within an isolated python environment, install via [pipx](https://pypa.github.io/pipx/):
 ```shell
 pipx install 'norite'
 ```
 
 ## Documentation
-Checkout the documentation for norite here:
+Checkout the documentation for norite here: [documentation](https://github.com/prdx23/norite/wiki)
 
 
 ## Inspiration
-Norite takes inspiration from [Zola's](https://www.getzola.org/) features and its way of organizing content, borrows a few concepts from [Hugo](https://gohugo.io), and references  [Pelican](https://blog.getpelican.com/)'s and [Mkdocs](https://www.mkdocs.org/)'s internal implementations for a few things. I would happily recomend using any of these excellent SSGs!
-
+Norite takes inspiration from [Zola's](https://www.getzola.org/) features and its way of organizing content, borrows a few concepts from [Hugo](https://gohugo.io), and references  [Pelican](https://blog.getpelican.com/)'s and [Mkdocs](https://www.mkdocs.org/)'s internal implementations for a few things. I would happily recommend using any of these excellent SSGs!
 
 
+## License
+**MIT License**: Copyright (c) 2022 - 2022 Arsh  
+[License.txt](https://github.com/prdx23/norite/blob/master/LICENSE.txt)

changelog

@@ -0,0 +1,3 @@
+
+v0.1.0
+- Initial release of norite on pypi

norite/console.py

@@ -7,12 +7,12 @@
 
 from norite.utils.init import init
 from norite.utils.server import serve
-from norite.utils.print_helpers import print_success
+from norite.utils.print_helpers import print_success, print_error
 
 
 parser = argparse.ArgumentParser(
     prog='norite',
-    description='A static site generator'
+    description='A static website generator'
 )
 subparsers = parser.add_subparsers(
     title='Commands',
@@ -23,12 +23,12 @@
 
 init_parser = subparsers.add_parser(
     'init',
-    help='Initialize a new project in current directory'
+    help='Initialize a new project in the current directory'
 )
 
 build_parser = subparsers.add_parser(
     'build',
-    help='Delete output directory and rebuild the site'
+    help='Delete the output directory and rebuild the site'
 )
 
 serve_parser = subparsers.add_parser(
@@ -58,7 +58,7 @@ def console():
         return
 
     if not Path('config.toml').exists():
-        print('config.toml not found')
+        print_error('Error: config.toml not found')
         return
 
     config = parse_toml_config(Path('config.toml'))

norite/utils/rss.py

@@ -10,7 +10,7 @@ def compile_rss(content_tree, global_context):
     rss_template_file = Path('source/templates') / filename
 
     if not rss_template_file.exists():
-        print_error(f'\nrss template "{rss_template_file}" not found\n')
+        print_error(f'\nError: rss template "{rss_template_file}" not found\n')
         return
 
     rss_template = environment.get_template(rss_template_file.name)

norite/utils/server.py

@@ -31,7 +31,7 @@ def run(self, output, host, port):
             try:
                 httpd.serve_forever()
             except KeyboardInterrupt:
-                print("\nKeyboard interrupt received, exiting.")
+                print("\nKeyboard interrupt received, exiting...")
 
 
 class Watcher:

setup.py

@@ -1,13 +1,40 @@
 import setuptools
 
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
 
 setuptools.setup(
     name='norite',
-    version='0.1',
+    version='0.1.0',
     author='Arsh',
     author_email='[email protected]',
-    description='',
+    description='A simple static website generator powered by Jinja2',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url='https://github.com/prdx23/norite',
     packages=setuptools.find_packages(),
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Development Status :: 3 - Alpha',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Text Processing :: Markup :: Markdown',
+        'Topic :: Text Processing :: Markup :: HTML',
+    ],
+    keywords='static web site generator SSG jinja jinja2 markdown',
+    project_urls={
+        'Source': 'https://github.com/prdx23/norite',
+        'Tracker': 'https://github.com/prdx23/norite/issues',
+        'Documentation': 'https://github.com/prdx23/norite/wiki',
+    },
     python_requires='>=3.6',
     install_requires=[
         'toml',