| Name | pipefyUts JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Pipefy manipulator |
| upload_time | 2024-10-25 14:36:04 |
| maintainer | None |
| docs_url | None |
| author | Melque Lima |
| requires_python | None |
| license | MIT |
| keywords |
pipefyuts
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PipefyUts
#
### Installation
```sh
pip install pipefyUts
```
## GitHub
https://github.com/ZdekPyPi/PipefyUts
## Usage
<!-- //==================================================== -->
## Auth
##### python code
```py
from pipefyUts import Pipefy
ORG_ID = "<your_org_id>"
TOKEN = "<your_token>"
pfy = Pipefy(ORG_ID,TOKEN)
```
<!-- //==================================================== -->
## listMembers
```py
pfy.listMembers()
```
##### output
```json
[
{"id":1,"name":"name_1","email":"email_1@email.com"},
{"id":2,"name":"name_2","email":"email_2@email.com"},
{"id":3,"name":"name_3","email":"email_3@email.com"},
{"id":4,"name":"name_4","email":"email_4@email.com"}
]
```
<!-- //==================================================== -->
## listStartFormFields
```py
pfy.listStartFormFields(pipe_id="<pipe_id>")
```
##### output
```json
[
{"id":"field_1","label":"field_label_1"},
{"id":"field_2","label":"field_label_2"},
{"id":"field_3","label":"field_label_3"},
{"id":"field_4","label":"field_label_4"}
]
```
<!-- //==================================================== -->
## listCardsFromPhase
```py
pfy.listCardsFromPhase(phase_id="<phase_id>")
```
##### output
```json
[
{"id":"card_id_1","fields":[{...},{...},{...},...]},
{"id":"card_id_2","fields":[{...},{...},{...},...]},
{"id":"card_id_3","fields":[{...},{...},{...},...]},
{"id":"card_id_4","fields":[{...},{...},{...},...]}
]
```
<!-- //==================================================== -->
## createAttachment
```py
path = pfy.createAttachment(file_path="<my_file>")
```
##### output
```py
"orgs/123456-1234-1234-1234-123asd5as1ad5s1/uploads/123ad3-123ddas-123cs-123da-asdc21cas21/my_file.txt"
```
## cardCreation
### authentication first
```py
from pipefyUts import Pipefy,NewCard,CardField
ORG_ID = "<your_org_id>"
TOKEN = "<your_token>"
pfy = Pipefy(ORG_ID,TOKEN)
```
### create card schema
```py
class MyCard(NewCard):
#DEFAULT
__pipeid__ = "<my_pipe_id>"
__title__ = "<card_title>"
#PIPEFY FIELDS
description = CardField(str)
total_ammount = CardField(float)
files = CardField(list)
files = CardField(list,is_file_path=True)
```
### create card
```py
#CREATE CARD OBJECT
myNewCard = MyCard(
description = "AdtPro",
total_ammount = 123.46,
files = ["<owner_id>"],
files = [r".\Doc1.pdf",r".\Doc2.txt"]
)
#RUN CARD CREATION
pfy.createCard(card=myNewCard)
```
##### output
```json
{"id":"card_id"}
```
## deleteCard
```py
pfy.deleteCard(card_id="<card_id>")
```
Change Log
==========
1.0.0 (2024-04-26)
------------------
- First Release
1.0.9 (2024-07-25)
------------------
- File spaces upload adjustment
Raw data
{
"_id": null,
"home_page": null,
"name": "pipefyUts",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pipefyUts",
"author": "Melque Lima",
"author_email": "melque_ex@yahoo.com.br",
"download_url": "https://files.pythonhosted.org/packages/40/0b/60fabe93cd840843e4f24c4f9b419569704dfe9d6dce7af1aac65fa93c91/pipefyuts-1.1.0.tar.gz",
"platform": null,
"description": "# PipefyUts\r\n#\r\n### Installation\r\n\r\n```sh\r\npip install pipefyUts\r\n```\r\n\r\n## GitHub\r\nhttps://github.com/ZdekPyPi/PipefyUts\r\n\r\n\r\n## Usage\r\n\r\n<!-- //==================================================== -->\r\n## Auth\r\n##### python code\r\n```py\r\nfrom pipefyUts import Pipefy\r\n\r\nORG_ID = \"<your_org_id>\"\r\nTOKEN = \"<your_token>\"\r\n\r\npfy = Pipefy(ORG_ID,TOKEN)\r\n\r\n```\r\n\r\n<!-- //==================================================== -->\r\n## listMembers\r\n```py\r\n\r\npfy.listMembers()\r\n\r\n```\r\n##### output\r\n```json\r\n[\r\n {\"id\":1,\"name\":\"name_1\",\"email\":\"email_1@email.com\"},\r\n {\"id\":2,\"name\":\"name_2\",\"email\":\"email_2@email.com\"},\r\n {\"id\":3,\"name\":\"name_3\",\"email\":\"email_3@email.com\"},\r\n {\"id\":4,\"name\":\"name_4\",\"email\":\"email_4@email.com\"}\r\n]\r\n\r\n```\r\n<!-- //==================================================== -->\r\n## listStartFormFields\r\n```py\r\n\r\npfy.listStartFormFields(pipe_id=\"<pipe_id>\")\r\n\r\n```\r\n##### output\r\n```json\r\n[\r\n {\"id\":\"field_1\",\"label\":\"field_label_1\"},\r\n {\"id\":\"field_2\",\"label\":\"field_label_2\"},\r\n {\"id\":\"field_3\",\"label\":\"field_label_3\"},\r\n {\"id\":\"field_4\",\"label\":\"field_label_4\"}\r\n]\r\n```\r\n\r\n<!-- //==================================================== -->\r\n## listCardsFromPhase\r\n```py\r\n\r\npfy.listCardsFromPhase(phase_id=\"<phase_id>\")\r\n\r\n```\r\n##### output\r\n```json\r\n[\r\n {\"id\":\"card_id_1\",\"fields\":[{...},{...},{...},...]},\r\n {\"id\":\"card_id_2\",\"fields\":[{...},{...},{...},...]},\r\n {\"id\":\"card_id_3\",\"fields\":[{...},{...},{...},...]},\r\n {\"id\":\"card_id_4\",\"fields\":[{...},{...},{...},...]}\r\n]\r\n\r\n```\r\n<!-- //==================================================== -->\r\n## createAttachment\r\n```py\r\n\r\npath = pfy.createAttachment(file_path=\"<my_file>\")\r\n\r\n```\r\n##### output\r\n```py\r\n\"orgs/123456-1234-1234-1234-123asd5as1ad5s1/uploads/123ad3-123ddas-123cs-123da-asdc21cas21/my_file.txt\"\r\n\r\n```\r\n\r\n\r\n\r\n## cardCreation\r\n### authentication first\r\n```py\r\nfrom pipefyUts import Pipefy,NewCard,CardField\r\n\r\nORG_ID = \"<your_org_id>\"\r\nTOKEN = \"<your_token>\"\r\n\r\npfy = Pipefy(ORG_ID,TOKEN)\r\n\r\n```\r\n### create card schema\r\n```py\r\n\r\nclass MyCard(NewCard):\r\n #DEFAULT\r\n __pipeid__ = \"<my_pipe_id>\"\r\n __title__ = \"<card_title>\"\r\n\r\n #PIPEFY FIELDS\r\n description = CardField(str)\r\n total_ammount = CardField(float)\r\n files = CardField(list)\r\n files = CardField(list,is_file_path=True)\r\n\r\n\r\n```\r\n### create card\r\n```py\r\n#CREATE CARD OBJECT\r\nmyNewCard = MyCard(\r\n description = \"AdtPro\",\r\n total_ammount = 123.46,\r\n files = [\"<owner_id>\"],\r\n files = [r\".\\Doc1.pdf\",r\".\\Doc2.txt\"]\r\n)\r\n\r\n#RUN CARD CREATION\r\npfy.createCard(card=myNewCard)\r\n\r\n```\r\n\r\n\r\n##### output\r\n```json\r\n{\"id\":\"card_id\"}\r\n```\r\n\r\n## deleteCard\r\n```py\r\n\r\npfy.deleteCard(card_id=\"<card_id>\")\r\n\r\n```\r\n\r\nChange Log\r\n==========\r\n\r\n1.0.0 (2024-04-26)\r\n------------------\r\n- First Release\r\n\r\n1.0.9 (2024-07-25)\r\n------------------\r\n- File spaces upload adjustment\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pipefy manipulator",
"version": "1.1.0",
"project_urls": null,
"split_keywords": [
"pipefyuts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "400b60fabe93cd840843e4f24c4f9b419569704dfe9d6dce7af1aac65fa93c91",
"md5": "1af240379f54a4f6edd1da9b621960cf",
"sha256": "9992a7172a5ec9e5cc5580c9ca2c3bce2c386d671c6c4aab44edcddb88a922d1"
},
"downloads": -1,
"filename": "pipefyuts-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1af240379f54a4f6edd1da9b621960cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9076,
"upload_time": "2024-10-25T14:36:04",
"upload_time_iso_8601": "2024-10-25T14:36:04.617161Z",
"url": "https://files.pythonhosted.org/packages/40/0b/60fabe93cd840843e4f24c4f9b419569704dfe9d6dce7af1aac65fa93c91/pipefyuts-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 14:36:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pipefyuts"
}
