Client for the Plunet 3.0 SOAP API.
Project description
PyPlunet
Modern Python client for interacting with the Plunet SOAP 3.0 API.
About The Project
Modern Python client for interacting with the Plunet SOAP API, without having to deal with any of the soapiness.
Ready to use out of the box, you can jump directly into the business logic.
Pip install, import and start working. It really is as easy as that!
- Implements all services and methods as per Plunet 9.2
- Fully typed for validation and code completion support
- Fully documented methods with complete content of the Plunet JavaDocs.
Built With
Getting Started
Installation
Install via pip
pip install pyplunet
Or clone the repo
git clone https://github.com/kuhnemann/pyplunet.git
Usage
Install using pip like so:
pip install pyplunet
Initialize the client with the base URL of your Plunet instance, authenticate and start doing whatever you aim to do.
from pyplunet import PlunetClient
plunet_client = PlunetClient(base_url="YOUR_URL")
plunet_client.login(username=username, password=password)
order_result = plunet_client.order.get_order_object(order_id=1234)
Complex types and enums are included. Convenient when searching or creating entities:
from datetime import datetime, timedelta
from pyplunet import PlunetClient
from pyplunet.models import OrderIN, SearchFilter_Resource
from pyplunet.enums import ResourceType, ResourceStatus, WorkingStatus
plunet_client = PlunetClient(base_url="YOUR_URL")
plunet_client.login(username=username, password=password)
# prepare the searchfilter
sf_resource = SearchFilter_Resource(
contact_resourceID=-1,
languageCode="EN",
resourceType=ResourceType.PROJECT_MANAGER,
resourceStatus=ResourceStatus.ACTIVE,
workingStatus=WorkingStatus.INTERNAL
)
# get the result
pms_result = plunet_client.resource.search(search_filter_resource=sf_resource)
# prepare the OrderIN object. Fields are typed and corresponds to definition from XSD.
order_in = OrderIN(
currency="SEK",
customerContactID=1,
customerID=3,
deliveryDeadline=datetime.now() + timedelta(days=7),
orderDate=datetime.now(),
orderID=-1,
projectManagerID=11,
projectManagerMemo="Some memo!",
projectName="Project has a name",
rate=-1,
referenceNumber="This is the reference number",
subject="This is the subject!"
)
order_integer_result = plunet_client.order.insert2(order_in=order_in)
order_id = order_integer_result.data
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Henrik Kühnemann - @hkuhnemann - hello@yellownape.se
Project Link: https://github.com/kuhnemann/pyplunet
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.