Python Project from zero

Indice

Project Structure
Error Control

Project Structure

1. Structure

-  main.py: is the main file of project, this file is used for execute the program

-  setup.py: this script is the center of all activity in building, distributing and installing modules.

-  setup.cfg: configuration file for project.

-  pyproject.toml: this file contains build suystem requirements and information, with are used by pip to build the package. 
	https://python-poetry.org/docs/pyproject/ 

-  .gitignore: file contains all folder and files for git ignore.

-  app/: folder for code of program

-  assets/: folder for save documents, images, videos...

-  config/: folder that contains project necesary configuration.

-  config/requirements.txt: file contain all library used in project with each the version.

-  logs/: folder contains all code information like errors for example.

-  tests/: folder with all project tests.

2. Virtual Enviroment

Enviroment separated from local system for install all libraries that need the project.

There are many libraries for create a virtual enviroment but I'm going to used 'venv'

VENV

NOTE: add enviroment folder in .gitignore file

Installation

-  pip install virtualenv

Create Virtual Enviroment

-  python3 -m venv name_venv

Activate VENV

-  Windows: Scripts\bin\activate
-  Linux: Source env/bin/activate

Deactivate VENV

-  deactivate

3. Linter

Linter is plugging for check if code is good formating.

There are many linters, in this case I'm going to used 'PyLint'.

PyLint

Configuration file is .pylintrc

Installation

-  pip install pylint

Execute

For execute pylint is used pylint plus folder name.

-  pylint .

The dot means all project.

4. Code Formatter

Code formatting format code to correct and standart form.

In this case I'm going to used 'Black'

Black

Installation

-  pip install black
-  pip install black[jupyter]: for use black with jupyter notebook

Execute

For execute black is used black plus folder name

-  black .

The dot means all project

Error control

1. CI/CD

Continuous Intagration (CI): this is the practice that involves regulary and automatically building, testing and integratinmg code changes into shared code repository.

Continuous Deployment (CD): this is the practice of automatically deploying software changes to production as soon as they pass automated tests, without any manual intervention.

GitHub Actions

GitHub Actions is a feature of the GitHub platform that provides a way to automate software development workflows directly within GitHub. We are going to used for continuos integration(CI)

Steps

- Create folder .github/workflows in root folder.
- Add the file that GitHub Actions going to verify (You can create more than one): script_name-workflows.yml
- Push code and GitHib Actions recognize automatically.

NOTE: Don't forget give to github token permission for use workflow.

2. Pre-commit

We going used pre-commit for check some things before git will do the commit.

If there is some error, git don't do the commit.

Steps

- pip install pre-commit
- create file named .pre-commit-config.yaml in root
- pre-commit install

alejandrohp96 / python-project-from-zero Goto Github PK