Project description
Package Version Python Versions License
bc_time is the Binary City (BC) Time Application Programming Interface (API) Software Development Kit (SDK) for Python, that allows Python developers to develop integration with BC Time.
bc_time is maintained and published by Binary City.
Getting started
Assuming that you have a supported version of Python installed, you can first set up your environment with:
$ python venv .venv ... $ . .venv/bin/activate Then, you can install bc_time from PyPI with:
$ python pip install bc_time or install from source with:
$ git clone git@github.com:Binary-City/bc_time_api_sdk.git
$ cd bc_time_api_sdk
$ python pip install -r requirements.txt
$ python pip install -e .
Using bc_time
After you've installed bc_time, the next step is to set-up your credentials at:
$HOME/.bc_time/config
[default]
client_id = YOUR_CLIENT_ID
client_secret = YOUR_CLIENT_SECRET
crypt_key = YOUR_CRYPT_KEY
grant_type = YOUR_GRANT_TYPE ; authorisation_code | client_credentials | urn:ietf:params:oauth:grant-type:jwt-bearer
private_key_file_path = FILE_PATH_TO_YOUR_PRIVATE_KEY
time_domain = BETA_OR_OTHER_NON_PRODUCTION_TIME_DOMAIN ; Optional.
How to create a private/public key pair
Using OpenSSL, follow these to steps to generate a private & public key par
openssl genrsa -out privatekey.pem 1024
openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825
Then, from a Python interpreter:
>>> import bc_time
>>> visitors = bc_time.Visitors()
>>> response_data = visitors.get_all_using_pagination(filters={'filter_status': bc_time.Status.active})
>>> if response_data['status'] == bc_time.RequestStatus.success:
for visitor in response_data['data']:
print(visitor)
You also have the option to specify your credentials via the constructor of the Api class:
>>> import bc_time
>>> api = bc_time.Api(
client_id='YOUR_CLIENT_ID',
client_secret='YOUR_CLIENT_SECRET',
crypt_key='YOUR_CRYPT_KEY',
grant_type='YOUR_GRANT_TYPE' # Consider using the bc_time.GrantType constants, for example bc_time.GrantType.CLIENT_CREDENTIALS
)
>>> visitors = bc_time.Visitors(api)
>>> response_data = visitors.get_all_using_pagination()
>>> if response_data['status'] == bc_time.RequestStatus.success:
for visitor in response_data['data']:
print(visitor)
Using grant type, password (constant, bc_time.GrantType.USER_CREDENTIALS):
>>> import bc_time
>>> api = bc_time.Api(
client_secret = 'YOUR_CLIENT_SECRET', # If the client secret is specified in ~/.bc_time/config then this parameter can be safely omitted.
grant_type=bc_time.GrantType.USER_CREDENTIALS # Override grant type as specified in ~/.bc_time/config; consider using the bc_time.GrantType constant.
)
>>> api.token.username = 'THE_USERNAME'
>>> api.token.password = 'THE_PASSWORD'
>>> token_acquired, _ = api.token.request_token()
>>> if token_acquired:
employees = bc_time.Employees(api)
response_data = employees.get_all_using_pagination()
if response_data['status'] == bc_time.RequestStatus.success:
for employee in response_data['data']:
print(employee)
Available enumerators
- ApiAuthorisationType
- DeviceCommunicationType
- GrantType
- RequestStatus
- Status
Available classes
- Api
Available objects
- ApiAuthorisations
- Branches
- CompanyProfiles
- Controllers
- Departments
- Devices
- DailyOvertimeData
- Employees
- EmployeeLeave
- PeriodOvertimeData
- RawAttendance
- Settings
- Visitors
- VisitorGroups
Available methods
For (most) objects
- create
- create_many
- update
- update_many
- get_all_using_pagination
- get_one
- get_many
For membership/group objects
Please note that group objects also has access the the methods as defined for Objects.
- add_visitor_to_group
- remove_visitor_from_group
- get_all_members_using_pagination
All methods will return a Dictionary that - depending on the response - may contain the following keys:
- status
- data
Status IDs can be referenced using the enumerator bc_time.RequestStatus.
Documentation
Please consult our BC Time API documentation for more information.
Metadata
Release files for bc-time 8.3.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 |
|---|---|---|---|---|
| bc_time-8.3.0.tar.gz | 16.7 kB | Without provenance | Details for bc_time-8.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bc_time-8.3.0-py3-none-any.whl | Python 3 | none | any | Details for bc_time-8.3.0-py3-none-any.whl |
Total release size: 42.9 kB
Release files / bc_time-8.3.0.tar.gz
| Download URL | bc_time-8.3.0.tar.gz |
|---|---|
| Size | 16.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a25f8e3cc8424432dbdaf2345a1d45ffa60f260821081949e4c259ebd5fe1fc5
|
|
BLAKE2b-256 checksum How to use checksums |
e55a3d05955787da80fe75f318cd44cd0710edef546b92266438ba2bdd13801b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / bc_time-8.3.0-py3-none-any.whl
| Download URL | bc_time-8.3.0-py3-none-any.whl |
|---|---|
| Size | 26.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8173528378d39ff2cd1cdc1cac95c99894c999677011696be1b76fa8b463d5bd
|
|
BLAKE2b-256 checksum How to use checksums |
066e657f671154cd3c73b1bfc4287618e93443bd3a093ffbeb0d2c8c77ae1bfe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for bc-time 8.3.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.