Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kostyfisik/optimize-eig


https://github.com/kostyfisik/optimize-eig

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]



optimize-eig


optimize eig


Explore the docs »




Report Bug
·
Request Feature


Table of Contents



  1. About The Project


  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgments

## About The Project

optimize eig

(back to top)

## Getting Started

To run this project locally, you will need to install the prerequisites and follow the installation section.

### Prerequisites

This Project depends on the following projects.
* Poetry
```sh
pip install --user --upgrade poetry
```

* Poe the Poet
```sh
pip install --user --upgrade poethepoet
```

### Installation

1. Clone the repo
```sh
git clone https://github.com/kostyfisik/optimize-eig
cd optimize-eig
```
2. Install Poe the Poet and Poetry
```sh
pip install --user --upgrade poethepoet poetry
```
3. Install requirements for development
```sh
poe install-dev
```
4. Run tests
```sh
poe test
```

(back to top)

## Usage

Some useful examples of how this project can be used:

* Install requirements
```sh
poe install-dev
```

* Run tests
```sh
poe test
```

* Run the project
```sh
poe run
```

* Generate API documentation
```sh
poe doc
```

* Build a docker image for tests
```sh
poe docker-build --target test --build-tag 3.10-alpine
docker run -ti --rm optimize_eig:test-3.10-alpine
```

* Build a docker image to run the root files only without running any test
```sh
poe docker-build --target prod --build-tag 3.10-alpine --no-test
docker run -ti --rm optimize_eig:prod-3.10-alpine
```

_For more examples, please refer to the [Documentation](https://kostyfisik.github.io/optimize-eig/readme.html)_

(back to top)

## Roadmap

- [x] Add tests
- [x] Add code coverage
- [x] Improve documentation
- [ ] Include more tests

See the [open issues](https://github.com/kostyfisik/optimize-eig/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing

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!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## Contact

Konstantin Ladutenko - [@kostyfisik](https://github.com/kostyfisik) - [email protected]

Project Link: [https://github.com/kostyfisik/optimize-eig/](https://github.com/kostyfisik/optimize-eig/)

(back to top)

## Acknowledgments

This project was created using cookiecutter and NullHack's python-project-template:

* [NullHack's python-project-template](https://github.com/nullhack/python-project-template/)

(back to top)

## License

Distributed under the GPL_3.0 License. See [`LICENSE`](https://github.com/kostyfisik/optimize-eig/blob/main/LICENSE) for more information.

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/kostyfisik/optimize-eig.svg?style=for-the-badge
[contributors-url]: https://github.com/kostyfisik/optimize-eig/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/kostyfisik/optimize-eig.svg?style=for-the-badge
[forks-url]: https://github.com/kostyfisik/optimize-eig/network/members
[stars-shield]: https://img.shields.io/github/stars/kostyfisik/optimize-eig.svg?style=for-the-badge
[stars-url]: https://github.com/kostyfisik/optimize-eig/stargazers
[issues-shield]: https://img.shields.io/github/issues/kostyfisik/optimize-eig.svg?style=for-the-badge
[issues-url]: https://github.com/kostyfisik/optimize-eig/issues
[license-shield]: https://img.shields.io/badge/license-GPL_3.0-green?style=for-the-badge
[license-url]: https://github.com/kostyfisik/optimize-eig/blob/main/LICENSE