Noko Client
A simple Noko (formerly Freckle) API client implementation. Offers two different clients with different levels of flexibility to interact with the Noko API v2.
Full documentation on the NokoClient can be found here.
Installation
To get the latest stable release from PyPi:
pip install python-freckle-client
Requirements:
Version v0.5.0 and lower requires at least Python 3.8. Version v1.0.0 and upper require Python 3.10 and Pydantic v2.
Usage
The package offers three different clients:
- NokoClient (Noko's v2 API)
- FreckleClientV2 (Noko's v2 API)
- FreckleClient (Noko's v1 API) <- Deprecated!
To use the NokoClient, just import the client, create an instance and call the desired method:
from noko_client.client import NokoClient
client = NokoClient('access_token')
entries = client.list_entries(from_="2023-08-01", to=datetime(2023, 8, 15))
To use the FreckleClient or the FreckleClientV2, just import the client, create an instance and call the fetch_json method:
from freckle_client.client import FreckleClient
client = FreckleClient('account_name', 'api_token')
entries = client.fetch_json(
'entries',
query_params={
'per_page': 1000,
'search[from]': '2015-01-01',
'search[to]': '2015-01-31',
'search[projects]': [1423, 24545, ],
}
)
Similarly, to use the V2 API:
from freckle_client.client import FreckleClientV2
client = FreckleClientV2('access_token')
entries = client.fetch_json(
'entries',
query_params={
'from': '2015-01-01',
'to': '2015-01-31',
'billable': 'true',
'project_ids': '12345,67890'
}
)
Contribute
If you want to contribute to this project, please fork this repository and clone your fork, then set up a virtual environment:
virtualenv -p 3.10 venv
source venv/bin/activate
pip install -r requirements-dev.txt
Create a new branch, implement your feature or fix, and send us a pull request.
Metadata
Release files for python-freckle-client 1.1.2
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 |
|---|---|---|---|---|
| python-freckle-client-1.1.2.tar.gz | 23.6 kB | Without provenance | Details for python-freckle-client-1.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| python_freckle_client-1.1.2-py3-none-any.whl | Python 3 | none | any | Details for python_freckle_client-1.1.2-py3-none-any.whl |
Total release size: 52.2 kB
Release files / python-freckle-client-1.1.2.tar.gz
| Download URL | python-freckle-client-1.1.2.tar.gz |
|---|---|
| Size | 23.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88d4fabbb38a6a89364f75a57e0d87d739e58e87660efb0ed1ff986669190ae5
|
|
BLAKE2b-256 checksum How to use checksums |
4dc84ea7994d5d0a937501c18d949777dc0f49c964d59e8daab6c1d0819a794d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.13
|
Release files / python_freckle_client-1.1.2-py3-none-any.whl
| Download URL | python_freckle_client-1.1.2-py3-none-any.whl |
|---|---|
| Size | 28.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
22ee21d2960e0b0f50714ecb6594b2586dc06b8628fa9fd701ee68b4051673e7
|
|
BLAKE2b-256 checksum How to use checksums |
19d775555fdd534eda5c928c2484e0c5947bb42b05983fe1d0afc1e796f7f673
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.13
|
Security for python-freckle-client 1.1.2
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.