Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabienarcellier/spike-prefect
https://github.com/fabienarcellier/spike-prefect
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/fabienarcellier/spike-prefect
- Owner: FabienArcellier
- License: mit
- Created: 2020-07-26T14:48:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T11:20:19.000Z (about 2 years ago)
- Last Synced: 2023-03-10T21:48:04.021Z (almost 2 years ago)
- Language: Python
- Size: 246 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## blueprint-python3
[](https://github.com/FabienArcellier//blueprint-python3/actions/workflows/main.yml)
blueprint to implement a simple spike with python3
* test python code
* use jupyter notebook with python dependencies
* ...
The implementation is compatible with python 3
## Getting started
1. clone this repository
2. remove .git directory
## The latest version
You can find the latest version to ...
```bash
git clone https://github.com/FabienArcellier/blueprint-python3.git
```
## Usage
You can run the application with the following command
```bash
python src/app/main.py
```
### Run in docker container
Vous pouvez exécuter ce template avec docker. L'image fabriquée peut être distribuée et utiliser pour déployer votre application
sur un environnement de production.
```bash
docker-compose build
docker-compose run app
```
## Developper guideline
### Add a dependency
``bash
poetry add requests
``
### Install development environment
Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.
```bash
poetry install
```
### Update release dependencies
Use make to instanciate a python virtual environment in ./venv and freeze
dependencies version
```bash
poetry update update
```
### Activate the python environment
When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :
```bash
poetry shell
```
### Run the continuous integration process
Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.
```bash
$ poetry run alfred ci
```
## Contributors
* Fabien Arcellier
## License
MIT License
Copyright (c) 2018-2022 Fabien Arcellier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.