Python package boilerplate (IDU)

Installation

The library can be installed with pip:

pip install git+https://github.com/vasilstar97/python-package-boilerplate@main

How to use

Use the library by importing classes from my_package:

from my_package.my_module_1 import MyClass

For more detailed use case see our examples.

Data

All the required data is stored in examples data folder.

Examples

Next examples will help one to get used to the library:

1. Main example of the library.
2. ...

Documentation

Detailed information and description of the library is available in documentation.

Project Structure

The latest version of the library is available in the main branch.

The repository includes the following directories and modules:

• my_package directory with the library code:
  • ...
  • ...
• tests pytest testing
• examples examples of how the library works
• docs documentation sources

Developing

...

License

The project has BSD-3-Clause license

Acknowledgments

...

Contacts

You can contact me:

• Vasilii Starikov - assistant

Also, you are welcomed to the issues section!

Publications

• My publication name from scholar or something
• ...