Metadata-Version: 2.1
Name: wagtail-seo
Version: 0.0.1
Summary: Search engine and social media optimization for Wagtail.
Home-page: https://github.com/coderedcorp/wagtail-seo
Author: CodeRed LLC
Author-email: info@coderedcorp.com
License: BSD license
Description: Wagtail SEO
        ===========
        
        Search engine and social media optimization for Wagtail.
        
        (COMING SOON - Work in progress)
        
        [Source code on GitHub](https://github.com/coderedcorp/wagtail-seo)
        
        
        Contributing
        ------------
        
        To set up your development environment:
        
        1. Create a new environment:
        
        ```
        python -m venv ./venv/
        
        # Mac and Linux
        source ./venv/bin/activate
        
        # Windows (PowerShell)
        ./venv/Scripts/Activate.ps1
        ```
        
        2. Enter the source code directory and install the package locally with
           additional development tools:
        
        ```
        pip install -r requirements-dev.txt
        ```
        
        3. Write some code.
        
        4. Next, run the static analysis tools:
        
        ```
        flake8 ./wagtailseo/
        mypy ./wagtailseo/
        codespell ./wagtailseo/ ./docs/
        
        ```
        
        5. Next, run the units tests. A simple Wagtail project using Wagtail SEO is
           in the `testproject/` directory. The tests will generate a visual HTML file
           at `htmlcov/index.html` when finished, which you can open in your browser.
        ```
        pytest ./testproject/
        ```
        
        6. To build the documentation, run the following, which will output to the
           `docs/_build/html/` directory.
        ```
        sphinx-build -M html ./docs/ ./docs/_build/ -W
        ```
        
        7. To create a python package, run the following, which will output the package
           to the `dist/` directory.
        ```
        python setup.py sdist bdist_wheel
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Description-Content-Type: text/markdown
