Model for new projects in Python aiming to facilitate and standardize the creation of projects with the PyCharm IDE.
- Project configuration file setup.py.
- Compressed file of IDE settings (settings.zip) File -> Manage IDE Settings -> Import Settings...
- Folder for documentation using MkDocs. Configuration
file mkdocs.yml.
- Theme for documentation using mkdocs-material.
- Log folder using Loguru for logging. Configuration file (loguru_conf.py).
- Folder for testing using unittest.
- .gitignore file generated by Toptal with python and pycharm+all tags.
- Prospector configuration file to improve code quality (.prospector.yaml).
- Installation of the Blue library to format the code according to PEP8.
- Installation of the isort library to sort the imports, of the codes, in alphabetical order.
pip install mkdocs- Install MKDocsmkdocs new .- Create a new sitemkdocs serve- Serve the sitemkdocs build- Build the sitepip install mkdocs-material- Install the theme material
pip install loguru- Install Loguruloguru_conf.py- Configuration file for Logurulogs- Folder for logs
pip install prospector- Install Prospector.prospector.yaml- Configuration file for Prospectorprospector- Command to run Prospector
pip install blue- Install Blueblue .- Command to run Blue on the current folder
pip install isort- Install isortisort .- Command to run isort on the current folder