easyllm 0.0.1

Description

Python Project Template

This is a template for Python projects. It is intended to be a starting point for new projects, and provides a structure that can be used consistently across projects.

Documentation: https://philschmid.github.io/python-project-template/

Getting Started

Fork the repository and clone it to your local machine. Then, run the following commands to rename all folders, files and variable from myproject to the name of your project:

newproject="mynewproject"
# rename and delete the project folder
mv  myproject/ mynewproject/
# rename the project in the pyproject.toml file
sed -i "" "s/myproject/mynewproject/g" pyproject.toml

Adjust documentation in docs/index.md and README.md to your needs.

Scipts

The following scripts are available:

• make style: run the ruff fix
• make check: run the ruff check
• make test: run the tests

Features

• Python version: 3.8
• project structure: pyproject.toml and src/
• Building system: Hatch
• lint, format, sorting with ruff
• testing with pytest
• cli suppored with cli.py file and installed automatically. -> $ myproject --help to see the cli options
• type checking with mypy -> remove mypy from pyproject.toml and makefile if not needed
• documentation with mkdocs with automatic deployment to github pages through and support for docstrings using (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). More extension here: https://chrieke.medium.com/the-best-mkdocs-plugins-and-customizations-fc820eb19759
  • for auto deployment enable permissions for github actions: https://github.com/ad-m/github-push-action/issues/96#issuecomment-889984928

Acknowledgements

This project was insipred by the structure of fastapi and created with Hatch.