Compare commits
No commits in common. "b20346893954436e6372be9a3ffeb240edfa7de1" and "e9380a127abc5d6e9c034e0f65ff1b80925ea9d0" have entirely different histories.
b203468939
...
e9380a127a
|
@ -3,7 +3,7 @@ on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- 'v[0-9]+.[0-9]+.[0-9]+'
|
- 'v[0-9]+.[0-9]+.[0-9]+'
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Package:
|
Package:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
name: Python Ruff Code Quality
|
name: Python Ruff Code Quality
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ruff:
|
ruff:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: Run Python tests (through Pytest)
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Test:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: Verify Python project can be installed, loaded and have version checked
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Test:
|
||||||
|
|
|
@ -1,17 +0,0 @@
|
||||||
When contributing code to this project, you MUST follow these principles:
|
|
||||||
|
|
||||||
- Code should be easy to read and understand.
|
|
||||||
- Keep the code as simple as possible. Avoid unnecessary complexity.
|
|
||||||
- Use meaningful names for variables, functions, etc. Names should reveal intent.
|
|
||||||
- Functions should be small and do one thing well. They should not exceed a few lines.
|
|
||||||
- Function names should describe the action being performed.
|
|
||||||
- Only use comments when necessary, as they can become outdated. Instead, strive to make the code self-explanatory.
|
|
||||||
- When comments are used, they should add useful information that is not readily apparent from the code itself.
|
|
||||||
- Properly handle errors and exceptions to ensure the software's robustness.
|
|
||||||
- Use exceptions rather than error codes for handling errors.
|
|
||||||
- Consider security implications of the code. Implement security best practices to protect against vulnerabilities and attacks.
|
|
||||||
- Documentation should document semantics, not syntax.
|
|
||||||
- Prefer importing modules, not individual items from modules.
|
|
||||||
- Do not use f-strings in logging statements.
|
|
||||||
- Loop variables and walrus-expression-variables should be deleted when
|
|
||||||
unneeded to keep scope clean, and to avoid accidental use.
|
|
2
LICENSE
2
LICENSE
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2024-2025 Jon Michael Aanes
|
Copyright (c) 2024 Jon Michael Aanes
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
29
README.md
29
README.md
|
@ -92,9 +92,7 @@ depo.get_amount_of_asset(BTC)
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
This project requires [Python](https://www.python.org/) 3.8 or newer.
|
All requirements can be installed easily using:
|
||||||
|
|
||||||
All required libraries can be installed easily using:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
@ -106,38 +104,15 @@ Full list of requirements:
|
||||||
- [krakenex](https://pypi.org/project/krakenex/)
|
- [krakenex](https://pypi.org/project/krakenex/)
|
||||||
- [frozendict](https://pypi.org/project/frozendict/)
|
- [frozendict](https://pypi.org/project/frozendict/)
|
||||||
- [fin-defs](https://gitfub.space/Jmaa/fin-defs)
|
- [fin-defs](https://gitfub.space/Jmaa/fin-defs)
|
||||||
- [pbc-client](https://gitfub.space/Jmaa/pbc-client)
|
|
||||||
- [dataclassabc](https://pypi.org/project/dataclassabc/)
|
- [dataclassabc](https://pypi.org/project/dataclassabc/)
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
|
||||||
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
Testing requires the [pytest](https://docs.pytest.org/en/stable/) library.
|
|
||||||
|
|
||||||
Run tests with the following command:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
pytest test
|
|
||||||
```
|
|
||||||
|
|
||||||
Test coverage can be run using the [`pytest-cov`](https://pypi.org/project/pytest-cov/) extension:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
pytest --cov=fin_depo test
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
```
|
```
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2024-2025 Jon Michael Aanes
|
Copyright (c) 2024 Jon Michael Aanes
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
__version__ = '0.1.51'
|
__version__ = '0.1.50'
|
||||||
|
|
1
setup.py
1
setup.py
|
@ -119,7 +119,6 @@ REQUIREMENTS_MAIN = [
|
||||||
'krakenex',
|
'krakenex',
|
||||||
'frozendict',
|
'frozendict',
|
||||||
'fin-defs @ git+https://gitfub.space/Jmaa/fin-defs.git',
|
'fin-defs @ git+https://gitfub.space/Jmaa/fin-defs.git',
|
||||||
'pbc-client @ git+https://gitfub.space/Jmaa/pbc-client.git',
|
|
||||||
'dataclassabc',
|
'dataclassabc',
|
||||||
]
|
]
|
||||||
REQUIREMENTS_TEST = [
|
REQUIREMENTS_TEST = [
|
||||||
|
|
Loading…
Reference in New Issue
Block a user