Skip to content

Flying-Free/pyopenproject

Repository files navigation

PyOpenProject

Codacy Badge Codacy Badge Run Test Cases

Python library to interact with OpenProject API.

from pyopenproject.openproject import OpenProject

op = OpenProject(url="http://localhost:8080", api_key="6289058256894568479567886794")
user = op.get_user_services().create(
    login="h.wurst",
    email="h.wurst@openproject.com",
    first_name="Hans",
    last_name="Wurst",
    admin=False,
    language="de",
    status="active",
    # Password minimum is 10 characters)
    password="h.wurst1234567890"
)

This library could be understood as a compendium of OpenProject endpoints services to use in a client project with the purpose of interact with OpenProject instance through its API.

Installing pyopenproject

PyOpenProject is available on PyPI:

python -m pip install pyopenproject

Documentation

Contributing

If you want to contribute, please:

  1. Fork it (https://github.com/Flying-Free/pyopenproject/fork)
  2. Create your feature branch (git checkout -b feature/newEndpoint)
  3. Commit your changes (git commit -am 'Add some new Endpoint')
  4. Push to the branch (git push origin feature/newEndpoint)
  5. Create a new Pull Request

Authors

Contributors