cookiecutter-pytorch-pl-tb

Minimal Cookiecutter template for the projects using pytorch, pytorch-lightning, and tensorboard. This cookiecutter is developed by forking pytest-dev /cookiecutter-pytest-plugin as a boilerplate.

This template requires Cookiecutter 1.4.0 "Shortbread" or higher

Getting Started

Install Cookiecutter and generate a new pytest plugin project:

$ pip install cookiecutter
$ cookiecutter https://github.com/Ohyeon5/cookiecutter-pytorch-pl-tb

Cookiecutter prompts you for information regarding your plugin:

full_name [Ohhyeon Choung]: your_first_name your_last_name
email [[email protected]]: [email protected]
github_username [Ohyeon5]: your_username
plugin_name [foobar]: awesome
module_name [awesome]: awesome
short_description [A simple plugin to use with pytest]:
version [0.1.0]:
pytest_version [2.9.1]:
Select docs_tool:
1 - mkdocs
2 - sphinx
3 - none
Choose from 1, 2, 3 [1]: 1
Select license:
1 - MIT
2 - BSD-3
3 - GNU GPL v3.0
Choose from 1, 2, 3 [1]: 2
INFO:post_gen_project:Moving files for mkdocs.

There you go - you just created a minimal pytest plugin:

pytest-awesome/
├── LICENSE
├── README.rst
├── docs
│   └── index.md
├── mkdocs.yml
├── pytest_awesome.py
├── setup.py
├── tests
│   ├── conftest.py
│   └── test_awesome.py
└── tox.ini

Features

Installable PyPI package featuring a setup.py.
Boiler plates for pytorch, pytorch-lightning, and tensorboard based deep learning project
Test suite running tox and pytest that makes sure your plugin is working as expected
Working example code for a fixture, a cli option, as well as a pytest.ini option
Comprehensive README.rst file that contains useful information about your plugin
Continuous integration configuration for AppVeyor
Optional documentation with either Sphinx or MkDocs
Choose from several licenses, such as MIT, BSD-3, Apache v2.0, GNU GPL v3.0, or MPL v2.0

Resources

Please consult the pytest docs for more information on hooks at pytest hook reference.

Contribute

We welcome you to contribute to this project. Please visit the documentation to get started!

Issues

If you encounter any problems, please file an issue along with a detailed description.

Code of Conduct

Everyone interacting in the Cookiecutter pytest Plugin project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

License

Distributed under the terms of the MIT license, Cookiecutter pytest Plugin is free and open source software.

ohyeon5 / cookiecutter-pytorch-pl-tb Goto Github PK