🤖 Repository layout updated to latest version
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
This commit is contained in:
parent
a27ffe6ddb
commit
51baddc8f2
|
@ -1,3 +1,7 @@
|
||||||
|
# WARNING!
|
||||||
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
name: Build Python Container
|
name: Build Python Container
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
# WARNING!
|
||||||
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
name: Package Python
|
name: Package Python
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
# WARNING!
|
||||||
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
name: Run Python tests (through Pytest)
|
name: Run Python tests (through Pytest)
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
# WARNING!
|
||||||
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
|
|
||||||
name: Verify Python project can be installed, loaded and have version checked
|
name: Verify Python project can be installed, loaded and have version checked
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
|
|
@ -1,3 +1,14 @@
|
||||||
|
<!-- WARNING! -->
|
||||||
|
<!-- THIS IS AN AUTOGENERATED FILE! -->
|
||||||
|
<!-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! -->
|
||||||
|
|
||||||
|
# Conventions
|
||||||
|
|
||||||
|
When contributing code to this project, you MUST follow the requirements
|
||||||
|
specified here.
|
||||||
|
|
||||||
|
## Code Conventions
|
||||||
|
|
||||||
When contributing code to this project, you MUST follow these principles:
|
When contributing code to this project, you MUST follow these principles:
|
||||||
|
|
||||||
- Code should be easy to read and understand.
|
- Code should be easy to read and understand.
|
||||||
|
@ -10,3 +21,16 @@ When contributing code to this project, you MUST follow these principles:
|
||||||
- Properly handle errors and exceptions to ensure the software's robustness.
|
- Properly handle errors and exceptions to ensure the software's robustness.
|
||||||
- Use exceptions rather than error codes for handling errors.
|
- 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.
|
- 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.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
When contributing test to this project, you MUST follow these principles:
|
||||||
|
|
||||||
|
- Do not use any testing libraries other than `pytest`.
|
||||||
|
- Mocking is the root of all evil. Writing your own stubs is much more
|
||||||
|
preferable.
|
||||||
|
|
12
README.md
12
README.md
|
@ -1,8 +1,6 @@
|
||||||
<!--- WARNING --->
|
<!-- WARNING! -->
|
||||||
<!--- THIS IS AN AUTO-GENERATED FILE --->
|
<!-- THIS IS AN AUTOGENERATED FILE! -->
|
||||||
<!--- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN --->
|
<!-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Personal Data Fetcher Systems
|
# Personal Data Fetcher Systems
|
||||||
|
|
||||||
|
@ -73,13 +71,12 @@ Full list of requirements:
|
||||||
- [fin-depo](https://gitfub.space/Jmaa/fin-depo)
|
- [fin-depo](https://gitfub.space/Jmaa/fin-depo)
|
||||||
- [secret_loader](https://gitfub.space/Jmaa/secret_loader)
|
- [secret_loader](https://gitfub.space/Jmaa/secret_loader)
|
||||||
- [requests-util](https://gitfub.space/Jmaa/requests_util)
|
- [requests-util](https://gitfub.space/Jmaa/requests_util)
|
||||||
|
- [clients](https://gitfub.space/Jmaa/clients)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
||||||
|
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
Testing requires the [pytest](https://docs.pytest.org/en/stable/) library.
|
Testing requires the [pytest](https://docs.pytest.org/en/stable/) library.
|
||||||
|
@ -96,7 +93,6 @@ Test coverage can be run using the [`pytest-cov`](https://pypi.org/project/pytes
|
||||||
pytest --cov=personal_data test
|
pytest --cov=personal_data test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
13
setup.py
13
setup.py
|
@ -1,8 +1,6 @@
|
||||||
# WARNING
|
# WARNING!
|
||||||
#
|
# THIS IS AN AUTOGENERATED FILE!
|
||||||
# THIS IS AN AUTOGENERATED FILE.
|
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN!
|
||||||
#
|
|
||||||
# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN.
|
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
@ -56,7 +54,6 @@ PACKAGE_DESCRIPTION_SHORT = """
|
||||||
This program collects several small data fetchers, for downloading personal
|
This program collects several small data fetchers, for downloading personal
|
||||||
data spread around the internet.""".strip()
|
data spread around the internet.""".strip()
|
||||||
|
|
||||||
|
|
||||||
def parse_version_file(text: str) -> str:
|
def parse_version_file(text: str) -> str:
|
||||||
match = re.match(r'^__version__\s*=\s*(["\'])([\d\.]+)\1$', text)
|
match = re.match(r'^__version__\s*=\s*(["\'])([\d\.]+)\1$', text)
|
||||||
if match is None:
|
if match is None:
|
||||||
|
@ -64,11 +61,9 @@ def parse_version_file(text: str) -> str:
|
||||||
raise Exception(msg)
|
raise Exception(msg)
|
||||||
return match.group(2)
|
return match.group(2)
|
||||||
|
|
||||||
|
|
||||||
with open(PACKAGE_NAME + '/_version.py') as f:
|
with open(PACKAGE_NAME + '/_version.py') as f:
|
||||||
version = parse_version_file(f.read())
|
version = parse_version_file(f.read())
|
||||||
|
|
||||||
|
|
||||||
REQUIREMENTS_MAIN = [
|
REQUIREMENTS_MAIN = [
|
||||||
'beautifulsoup4',
|
'beautifulsoup4',
|
||||||
'lxml',
|
'lxml',
|
||||||
|
@ -84,12 +79,12 @@ REQUIREMENTS_MAIN = [
|
||||||
'fin-depo @ git+https://gitfub.space/Jmaa/fin-depo.git',
|
'fin-depo @ git+https://gitfub.space/Jmaa/fin-depo.git',
|
||||||
'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader',
|
'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader',
|
||||||
'requests-util @ git+https://gitfub.space/Jmaa/requests_util',
|
'requests-util @ git+https://gitfub.space/Jmaa/requests_util',
|
||||||
|
'clients @ git+https://gitfub.space/Jmaa/clients',
|
||||||
]
|
]
|
||||||
REQUIREMENTS_TEST = [
|
REQUIREMENTS_TEST = [
|
||||||
'pytest',
|
'pytest',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name=PACKAGE_NAME,
|
name=PACKAGE_NAME,
|
||||||
version=version,
|
version=version,
|
||||||
|
|
Loading…
Reference in New Issue
Block a user