F5 project
Project description
F5 Project
Finlab Fugle for financial freedom.
Quickstart
Pipx (recommended)
Use pipx to create your F5 project with a template and install all dependencies.
cd ~/repos
pipx run --no-cache f5project create-project my_f5project
cd my_f5project
pip install -r requirements.txt
Then, follow these instructions to make it work:
- Put all your secrets in
.secrets/index.json
file - Run
python main.py
to see if it works - Run
scripts/setup_github_secrets.py
to sync your secrets with Github secrets - [Optional] Follow the instructions in
scripts/setup_github_secrets.py
to make it a pre-push Git hook git push
to deploy your code according to.github/workflows/main.yml
Traditional way
If you don't feel like using pipx, you can also run this with traditional pip.
cd ~/repos
mkdir my_f5project
cd my_f5project
python3 -m venv .venv
source .venv/bin/activate
pip install f5project
f5project f5project create-project .
pip install -r requirements.txt
Then, follow these instructions to make it work:
- Put all your secrets in
.secrets/index.json
file - Run
python main.py
to see if it works - Run
scripts/setup_github_secrets.py
to sync your secrets with Github secrets - [Optional] Follow the instructions in
scripts/setup_github_secrets.py
to make it a pre-push Git hook git push
to deploy your code according to.github/workflows/main.yml
Why?
This library makes it easier to use Finlab/Fugle with GCF and CD/CD.
When deploying your code on Cloud. Many troubles come up. This library helps you to solve them. Including:
- Read config from a simle JSON file or environment variables, depending on your environment.
- Extract Fugle config and certificate from config, dynamically generate them as needed, by-passing Fugle's restriction that only accepts files as input.
- Provide a decorator to make your function a GCF endpoint, without worrying about the request/response format.
- Simulate GCF request locally.
- Sync Github secrets with local config, make CI/CD easier.
With all of these, you can focus on your trading strategy and iterate faster, letting this library handle the rest.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
f5project-0.0.27.tar.gz
(12.9 kB
view hashes)
Built Distribution
f5project-0.0.27-py3-none-any.whl
(16.5 kB
view hashes)
Close
Hashes for f5project-0.0.27-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afd870ef0c748c1678d92bc2f5543f0a2cfdc5f6ed4cfd43ba610d109ee8a48d |
|
MD5 | a8ae130969121d16990ec720eee1e80d |
|
BLAKE2b-256 | 41cbb750f323d619d537545aab05ffe7e9be43497d5b393260aebd51c496667b |