Fish n Chips
A simple, pip installable package sample with a console entry point with demonstration purposes.
This package can be downloaded for examination as a sample, or it can be modified for your own purposes.
Note: cookiecutter-pypippackage can be used to create a project similar to this layout.
You can clone the repository via git:
git clone https://github.com/caglartoklu/fishnchips
TODO: how to install the package?
TODO: how to run it from command line?
TODO: how to run the tests from command line?
TODO: Requirements
Any text editor such as Vim or Emacs is always fine.
If you use Visual Studio, .vs directory is already added to .gitignore file.
If you use PyCharm, .idea directory is already added to .gitignore file.
When you use PyCharm to inspect the project, "Inspection Results" window will include the .eggs directory.
To ignore the inspection for that directory, right-click on the directory, select Mark Directory as and then select Excluded.
.private or _private directory (you can create them yourself if you need a directory that will not be tracked by git) are already added to .gitignore file.
TODO: Modifying
TODO: how to add new command line options?
- the README.rst file (this very file) is written in reStructuredText.
- Python packaging: https://packaging.python.org/
- How To Package Your Python Code: https://python-packaging.readthedocs.io/en/latest/