Skip to content

gisce/py-timenet

Repository files navigation

Client API Timenet

Introducció

Client API per a Timenet, una eina de gestió de temps i projectes. Aquesta biblioteca permet interactuar amb l'API de Timenet per gestionar marcatges, grups, treballadors, projectes i configuració d'empresa.

Instal·lació

pip install timenet

Funcionalitats

Funcions principals

  • Marcatges
  • Grups
  • Treballadors
  • Projectes
  • Configuració d'empresa

Exemple d'ús

A continuació es mostra un exemple bàsic d'ús de l'API:

from timenet import TimenetClient

# Crear una instància del client
tc = TimenetClient(token="XXXX")

# Obtenir la llista de treballadors
tc.workers.list()

Estratègia de validació de payloads

py-timenet és un wrapper prim sobre l'API pública de Timenet. Els mètodes que creen o modifiquen dades accepten diccionaris Python i els envien com a JSON sense aplicar validació local de camps, dates, identificadors o valors enumerats. La font de veritat d'aquesta validació és Timenet, de manera que el client preserva compatibilitat amb canvis de l'API i amb instal·lacions que puguin acceptar camps addicionals.

El contracte d'aquesta llibreria és construir correctament la URL, el mètode HTTP, els paràmetres de consulta i el cos JSON. Les operacions d'escriptura més delicades tenen tests específics per evitar regressions en aquests punts. Si un projecte necessita validació prèvia, és millor encapsular-la en una capa pròpia de l'aplicació o en helpers compatibles amb Python 2.7 que deleguin igualment la resposta final a Timenet.

Tests

python -m unittest discover -v

GitHub Actions executes the test suite on pull requests with Python 3.11 using the pinned dependencies in requirements-ci.txt.

Python 2.7 compatibility is kept as a local validation path only because GitHub hosted runners no longer provide a maintained Python 2.7 runtime:

python2.7 -m pip install -r requirements-py27.txt
python2.7 -m unittest discover -v

Contribució

Les contribucions són benvingudes! Si vols col·laborar, si us plau, fes un fork del repositori i envia un pull request.

Llicència

Aquest projecte està llicenciat sota la MIT License.

About

Timenet API Client in Python

Resources

License

Stars

0 stars

Watchers

4 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages