Welcome to john_toolbox 👋

This is my own toolbox to handle preprocessing production ready based on scikit-learn Pipeline but with more flexibility.

🏠 Homepage

💿 Installation with pip

pip install john-toolbox

💡 How to use the package ?

If you want examples, please refer to notebooks directory. It contains tutorials on how to use the package and other useful tutorials to handle end to end machine learning project.

🚧 Local development

💣 Installation guide

❗ by default, we install docker container with cpu only, if you want to install gpu mode :

make env

Comment in .env file at the root, the following lines :

DEVICE=cpu
DOCKER_RUNTIME=runc

Uncomment in .env file at the root, the following lines :

# DEVICE=gpu
# DOCKER_RUNTIME=nvidia

then :

make install

if you want to use with local domain name, you need to generate certificate ssl in local development instead of url with port like http://localhost:8885 :

make stop ssl

✨ Usage

Start project :

make start

Stop project :

make stop

Display logs of specific service

make logs svc="your_service_name_declared_in_docker_compose"

Go inside a docker container

./cli your_service_name_declared_in_docker_compose

🦸 Need help

make help

Url

• Develop with Jupyter Notebook : https://nb.johntoolbox.localhost
• Treafik (reverse proxy) : https://proxy.johntoolbox.localhost

Author

👤 Johnathan Nguyen

• GitHub: @nguyenanht

Show your support

Give a ⭐️ if this project helped you!

🤝 Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

How to contribute

Semantic Commit Messages

Every programmer in this project must respect a convention for every commit. The CI will not let you merge your branch into Develop.

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

• feat: (new feature for the user, not a new feature for build script)
• fix: (bug fix for the user, not a fix to a build script)
• docs: (changes to the documentation)
• style: (formatting, missing semicolons, etc.; no production code change)
• refactor: (refactoring production code, e.g. renaming a variable)
• test: (adding missing tests, refactoring tests; no production code change)
• chore: (updating grunt tasks etc.; no production code change)

References:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html

Useful link

• how to publish new version in pypi with poetry ? : https://johnfraney.ca/posts/2019/05/28/create-publish-python-package-poetry/
• how to create a new release ? : https://www.atlassian.com/fr/git/tutorials/comparing-workflows/gitflow-workflow
• how to generate docs : https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion
• how to deploy with github actions : https://blog.flozz.fr/2020/09/21/deployer-automatiquement-sur-github-pages-avec-github-actions/

This README was created with the markdown-readme-generator