miscellaneous-python

A repo where I present some of my Python scripts.

Requirements

Python 3.10 or newer is required (find it at Python.org or use pyenv).

poetry is recommended to use in this project, as the following examples assume that poetry is already installed.

Installation

You can also run this command in the root directory

poetry install

Testing

Run the following command in the tests/ directory

poetry run pytest

Documentation

As the repo's Read the Doc site is to be updated, please kindly use the docstring within scripts instead.

Contributing

Contributions are always welcome!

Send your ideas to the Issues or Discussions section, or even make a new PR.

Todo

• Add a CONTRIBUTING file
• Add a README file for subpackages
• Add documentation to the repo's Read the Doc site
• Implement GitHub Actions in production (e.g. Dependabot)

Author

👤 Minh Tran

License

Copyright © 2021 Minh Tran.