Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
About The Project
(back to top)
Getting Started
Installation
Installation with pip is simple as follows:
pip install impetus
Usage
For more examples, please refer to the Documentation
Developing locally
This project use poetry for dependency management, and is required for running impetus locally.
- Clone the repo
git clone https://github.com/dhmnr/impetus.git
- Install Dependencies
poetry install
- Run the command as follows
poetry shell run impetus --help
(back to top)
Roadmap
Minor Fixes
See the open issues for a full list of proposed features (and known issues).
(back to top)
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Top contributors:
(back to top)
License
Distributed under the MIT License. See LICENSE.txt
for more information.
(back to top)
Contact
Project Link: https://github.com/dhmnr/impetus
(back to top)
Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
(back to top)