https://github.com/sylhare/python-seed

Python Seed, template python structure to get started
https://github.com/sylhare/python-seed

Last synced: about 2 months ago
JSON representation

Python Seed, template python structure to get started

• Host: GitHub
• URL: https://github.com/sylhare/python-seed
• Owner: sylhare
• License: mit
• Created: 2020-03-08T19:19:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T01:08:45.000Z (3 months ago)
• Last Synced: 2024-10-12T19:33:41.199Z (3 months ago)
• Language: Python
• Size: 15.6 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Python Seed App

===============

Inspired by `MarshalJoe `__

This is a simple skeleton for a generic Python app.

It comes loaded with:

-  Project automation with

   `tox `__

-  Test with `pytest `__

-  Style with `pylint `__

As well a ``.gitignore``, ``.pylintrc`` config file, and simple

directory structure.

Get Started

-----------

You can fork the project and start your own with it.

You need to install tox `pip install tox` then run `tox` to install the dependencies.

The source files represents a hello world and can be removed / modified.

Setup

-----

Using Docker:

.. code:: bash

   # build the image:

   docker build -t seed-app .

   # Run image:

   docker run -it seed-app

Testing

-------

To find out more info about the testing configuration, check out the

``tox.ini`` file.

Use the ``requirements-dev.txt`` for libraries only used for tests or dev.

.. code:: bash

   # Run the test suite

   tox

   # Run the linter:

   tox -e lint

   # Run the coverage on the src module

   tox -e coverage

Misc Notes

----------

-  Make sure and edit the package title in ``setup.py`` to reflect your

   app name

-  If you have issue with tox and ``ModuleNotFoundError``, try set

   ``recreate`` to ``True`` in ``tox.ini``.