timone
Current version: 0.4.0
timone is a lightweight object router to store Git LFS objects on different storage backend, including AWS S3 compatible storage services.
Install
$ pip install timone
Configuration
timone can be configured by passing settings through environment variables, following the 12 factor principles.
Basic settings
- TIMONE_LOG_LEVEL: Python logging level (default: INFO).
- TIMONE_ENDPOINT_URL: URL to reach service.
- TIMONE_TOKEN_SECRET: secret for token based authentication.
- TIMONE_STORAGE: storage driver to use (default: DumbStorageDriver).
Currently supportingS3StorageDriver, for AWS S3 services, orDumbStorageDriver, for testing purposes. - TIMONE_OBJECT_EXPIRESIN: object availability in seconds (default: 3600).
S3StorageDriver settings
- TIMONE_STORAGE_S3_URL: S3 endpoint URL.
- TIMONE_STORAGE_S3_REGION: S3 region.
- TIMONE_STORAGE_S3_BUCKET: S3 bucket name.
- TIMONE_STORAGE_S3_KEY: S3 access key.
- TIMONE_STORAGE_S3_SECRET: S3 access secret.
Authentication and authorization
timone implements a simple token-based authentication system based on JWT, which streamlines authentication and authorization.
You can create tokens to access timone using pyjwt. For example, you can run the following command to create a token for user bob:
$ pyjwt --key=mykey encode user=bob
where key is the TIMONE_TOKEN_SECRET.
Deployment
timone is a WSGI application, thus it requires a WSGI HTTP Server, like gunicorn, to run.
You can run a timone instance using gunicorn as follows:
$ gunicorn 'timone.wsgi:run()'
Configuring GIT LFS
You can use timone to track files for the repository foo/bar as follows:
git config -f .lfsconfig remote.origin.lfsurl https://<timone_url>/foo/bar/info/lfs
where <timone_url> is the timone endpoint URL.
When pushing for the first time, Git will ask LFS credentials; here, you should use your username and token provided by the service administrator.
Issues
Please post an issue to report a bug or request new features.
Authors
- Giovanni Stracquadanio, dr.stracquadanio@gmail.com
Metadata
Release files for timone 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| timone-0.4.0.tar.gz | 7.9 kB | Without provenance | Details for timone-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| timone-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for timone-0.4.0-py3-none-any.whl |
Total release size: 16.6 kB
Release files / timone-0.4.0.tar.gz
| Download URL | timone-0.4.0.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c52a5a7dc44a64e39939207f5bda0a2dc7799a55416ebbec6e5d95a1bb8c85b
|
|
BLAKE2b-256 checksum How to use checksums |
4c7153226a422b2b35e0f7d2ef86432cd2ef376c7d44c5e16d4940c2601228b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0
|
Release files / timone-0.4.0-py3-none-any.whl
| Download URL | timone-0.4.0-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e10b0c601a13b86dc2d814e160c3c5544e7deb9e41c05e459799ffb54dc0293a
|
|
BLAKE2b-256 checksum How to use checksums |
8e0ddf17369d8301bf775afcd4d26379dc645c6db240956cf2d94c6d60e49183
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0
|
Security for timone 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.