projectal
A python client for the Projectal API.
Getting started
import projectal
import os
# Supply your Projectal server URL and account credentials
api_base = 'https://yourcompany.projectal.com'
api_username = os.environ.get('PROJECTAL_USERNAME')
api_password = os.environ.get('PROJECTAL_PASSWORD')
# Test communication with server
status = projectal.status()
# Test account credentials
projectal.login()
details = projectal.auth_details()
Changelog
4.3.1
- Fixed typo in "Getting started" example.
- Fixed typo in 4.3.0 Changelog.
4.3.0
Breaking changes:
- Added "PREDECESSOR_TASK" option when fetching projectal.Task with links
- Predecessor tasks will be returned as a list of tasks under the taskList attribute
- This attribute name is different to what you would see when using the REST API directly (planList). This change was necessary to allow for directly manipulating the list of links and then saving the task entity to commit any changes, since the REST API is expecting a different key for linking calls (taskList).
- Existing Predecessor Task linking methods were also updated to match the new linking functionality.
They now work as a reverse linker, automatically inverting the link relationship between
the task entities. This more closely matches what you would expect to see based on the Web UI.
I.e. When previously calling
some_task.link_predecessor_task(another_task)
, some_task would be set as a predecessor for another_task instead of the other way around. Now another_task would be set as the predecessor for some_task.
4.2.2
projectal.User.current_user_permissions()
fixed incorrect query.projectal.Webhook.list()
default limit increased to 1000.
4.2.1
Added classes allowing for the management of dynamic enums. The user must have the "List Management" permission to update enums.
New classes:
projectal.CompanyTypes
projectal.SkillLevels
projectal.StaffTypes
projectal.PriorityLevels
projectal.ComplexityLevels
projectal.CurrencyList
The current enum can be retrieved with get(), and updated with set(). For example, to return the current SkillLevels enum:
projectal.SkillLevels.get()
For each enum the entire list of key value pairs must be provided when calling set(), any existing values that are omitted from the dictionary will be removed, and any additional values will be added.
To update the SkillLevels enum with a new value:
new_value_added = { "Senior": 10, "Mid": 20, "Junior": 30, # new SkillLevel value "Beginner" "Beginner": 40, } projectal.SkillLevels.set(new_value_added)
To change the name of a value, set a new key name for the original value:
updated_value_name = { # changing "Senior" SkillLevel to "Expert" "Expert": 10, "Mid": 20, "Junior": 30, } projectal.SkillLevels.set(updated_value_name)
To remove an existing value, call set on a dictionary with that value removed:
value_removed = { "Senior": 10, "Mid": 20, # "Junior" SkillLevel removed } projectal.SkillLevels.set(new_value_added)
Updating the CurrencyList works differently to the other enums, since the names of values must match the alphabetic currency code and the value must match the numeric currency code. This will cause an exception if you try to change the name for any values.
Adding a new currency:
new_currency_added = { "AED": 784 ... # rest of the existing currencies ... # new currency to add with the alphabetic and numeric code "ZWL": 932, } projectal.CurrencyList.set(new_currency_added)
Removing an existing currency requires you to provide the numeric code for the currency as a negative value.
currency_removed = { # this currency will be removed "AED": -784 ... # rest of the existing currencies ... } projectal.CurrencyList.set(currency_removed)
4.2.0
Version 4.2.0 accompanies the release of Projectal 4.1.0
Minimum Projectal version is now 4.1.0.
Changed order of applying link types when an entity is initialized, prevents a type error with reverse linking in certain situations.
projectal.Task.reset_duration()
now supports adjustments with multi day calendar exceptions.projectal.Task.reset_duration()
location working days override base exceptions.projectal.TaskTemplate.list()
fixed incorrect query when using inherited method.
4.1.0
DateLimit.Max enum value changed from "9999-12-31" to "3000-01-01". This reflects changes to the Projectal backend that defines this as the maximum allowable date value. The front end typically considers this value as equivalent with having no end date.
Updated requirements.txt version for requests package
Minimum Projectal version is now 4.0.40
4.0.3
- When a dict object is passed to the update class method, it will be converted to the corresponding Entity type. Allows for proper handling of keys that require being treated as links.
4.0.2
Booking entity is now fetched with project field and either staff or resource field.
Added missing link methods for 'Booking' entity (Note, File)
Added missing link methods for 'Activity' entity (Booking, Note, File, Rebate)
Reduced maximum number of link methods to 100 for a single batch request to prevent timeouts under heavy load.
4.0.1
- Minimum Projectal version is now 4.0.0.
4.0.0
Version 4.0.0 accompanies the release of Projectal 4.0.
Added the
Activity
entity, new in Projectal 4.0.Added the
Booking
entity, new in Projectal 4.0.
3.1.1
- Link requests generated by 'projectal.Entity.create()' and 'projectal.Entity.update()' are now executed in batches. This is enabled by default with the 'batch_linking=True' parameter and can be disabled to execute each link request individually. It is recommended to leave this parameter enabled as this can greatly reduce the number of network requests.
3.1.0
Minimum Projectal version is now 3.1.5.
Added
projectal.Webhook.list_events()
. See API doc for details on how to use.Added
deleted_at
parameter toprojectal.Entity.get()
. This value should be a UTC timestamp from a webhook delete event.Added
projectal.ldap_sync()
to initiate a user sync with the LDAP/AD service configured in the Projectal server settings.Enhanced output of
projectal.Entity.changes()
function when reporting link changes. It no longer dumps the entire before-and-after list with the full content of each linked entity. Now reports three lists:added
,updated
,removed
. Entities within theupdated
list follow the sameold
vsnew
dictionary model for the data attributes within them. E.g:resourceList: [ 'added': [], 'updated': [ {'uuId': '14eb4c31-0f92-49d1-8b4d-507ab939003e', 'resourceLink': {'utilization': {'old': 0.1, 'new': 0.9}}}, ], 'removed': [] ]
This should result in slimmer logs that are much easier to understand as the changes are clearly indicated.
3.0.2
- Added
projectal.Entity.get_link_definitions()
. Exposes entity link definition dictionary. Consumers can inspect which links an Entity knows about and their internal settings. Link definitions that appear here are the links valid forlinks=[]
parameters.
3.0.1
Fixed fetching project with links=['task'] not being available.
Improved Permission.list(). Now returns a dict with the permission name as key with Permission objects as the value (instead of list of uuIds).
Added a way to use the aliasing feature of the API (new in Projectal 3.0). Set
api_alias = 'uuid'
to the UUID of a User object and all requests made will be done as that user. Restore this value to None to resume normal operation. (Some rules and limitations apply. See API for more details.)Added complete support for the Tags entity (including linkers).
3.0
Version 3.0 accompanies the release of Projectal 3.0.
Breaking changes:
The
links
parameter onEntity
functions now consumes a list of entity names instead of a comma-separated string. For example:# Before: projectal.Staff.get('<uuid>', links='skill,location') # No longer valid # Now: projectal.Staff.get('<uuid>', links=['skill', 'location'])
The
projectal.enums.SkillLevel
enum has had all values renamed to match the new values used in Projectal (Junior, Mid, Senior). This includes the properties on Skill entities indicating work time for auto-scheduling (nowjuniorLevel
,midLevel
,seniorLevel
).
Other changes:
Working with entity links has changed in this release. The previous methods are still available and continue to work as before, but there is no need to interact with the
projectal.linkers
methods yourself anymore.You can now modify the list of links within an entity and save the entity directly. The library will automatically determine how the links have been modified and issue the correct linker methods on your behalf. E.g., you can now do:
staff = projectal.Staff.get('<uuid>', links=['skill']) staff['firstName'] = "New name" # Field update staff['skillList'] = [skill1, skill2, skill3] # Link update staff.save() # Both changes are saved task = projectal.Task.get('<uuid>', links=['stage']) task['stage'] = stage1 # Uses a single object instead of list task.save()
See
examples/linking.py
for a more complete demonstration of linking capabilities and limitations.Linkers (
projectal.linkers
) can now be given a list of Entities (of one type) to link/unlink/relink in bulk. E.g:staff.unlink_skill(skill1) # Before staff.unlink_skill([skill1, skill2, skill3]) # This works now too
Linkers now strip the payload to only the required fields instead of passing on the entire Entity object. This cuts down on network traffic significantly.
Linkers now also work in reverse. The Projectal server currently only supports linking entities in one direction (e.g., Company to Staff), which often means writing something like:
staff.link_location(location) company.link_staff(staff)
The change in direction is not very intuitive and would require you to constantly verify which direction is the one available to you in the documentation.
Reverse linkers hide this from you and figure out the direction of the relationship for you behind the scenes. So now this is possible, even though the API doesn't strictly support it:
staff.link_location(location) staff.link_company(company)
Caveat: the documentation for Staff will not list Company links. You will still have to look up the Company documentation for the link description.
Requesting entity links with the
links=
parameter will now always ensure the link field (e.g.,taskList
) exists in the result, even if there are no links. The server may not always return a value, but we can use a default value ([] for lists, None for dicts).Added a
Permission
entity to correctly type Permissions in responses.Added a
Tag
entity, new in Projectal 3.0.Added
links
parameter toCompany.get_primary_company()
Department.tree()
: now consumes aholder
Entity object instead of a uuId.Department.tree()
: addedgeneric_staff
parameter, new in Projectal 3.0.Don't break on trailing slash in Projectal URL
When creating tasks, populate the
projectRef
andparent
fields in the returned Task object.Added convenience functions for matching on fields where you only want one result (e.g match_one()) which return the first match found.
Update the entity
history()
method for Projectal 3.0. Some new parameters allow you to restrict the history to a particular range or to get only the changes for a webhook timestamp.Entity objects can call
.history()
on themselves.The library now keeps a reference to the User account that is currently logged in and using the API:
api_auth_details
.
Known issues:
- You cannot save changes to Notes or Calendars via their holding entity. You
must save the changes on the Note or Calendar directly. To illustrate:
staff = projectal.Staff.get(<uuid>, links=['calendar']) calendar = staff['calendarList'][0] calendar['name'] = 'Calendar 2' # Cannot do this - will not pick up the changes staff.save() # You must do this for now calendar.save()
When creating Notes, the
created
andmodified
values may differ by 1ms in the object you have a reference to compared to what is actually stored in the database.Duration calculation is not precise yet (mentioned in 2.1.0)
2.1.0
**Breaking changes**: - Getting location calendar is now done on an instance instead of class. So `projectal.Location.calendar(uuid)` is now simply `location.calendar()` - The `CompanyType.Master` enum has been replaced with `CompanyType.Primary`. This was a leftover reference to the Master Company which was renamed in Projectal several versions ago. **Other changes**: - Date conversion functions return None when given None or empty string - Added `Task.reset_duration()` as a basic duration calculator for tasks. This is a work-in-progress and will be gradually improved. The duration calculator takes into consideration the location to remove non-work days from the estimate of working duration. It currently does not work for the time component or `isWorking=True` exceptions. - Change detection in `Entity.changes()` now excludes cases where the server has no value and the new value is None. Saving this change has no effect and would always detect a change until a non-None value is set, which is noisy and generates more network activity.2.0.3
- Better support for calendars.
- Distinguish between calendar containers ("Calendar") and the calendar items within them ("CalendarItem").
- Allow CalendarItems to be saved directly. E.G item.save()
- Fix 'holder' parameter in contact/staff/location/task_template not permitting object type. Now consumes uuId or object to match rest of the library.
Entity.changes()
has been extended with anold=True
flag. When this flag is true, the set of changes will now return both the original and the new values. E.g.
- Fixed entity link cache causing errors when deleting a link from an entity which has not been fetched with links (deleting from empty list).
2.0.2
- Fixed updating Webhook entities
2.0.1
- Fixed application ID not being used correctly.
2.0.0
- Version 2.0 accompanies the release of Projectal 2.0. There are no major changes since the previous release.
- Expose
Entity.changes()
function. It returns a list of fields on an entity that have changed since fetching it. These are the changes that will be sent over to the server when an update request is made. - Added missing 'packaging' dependency to requirements.
1.2.0
**Breaking changes**:- Renamed
request_timestamp
toresponse_timestamp
to better reflect its purpose. Automatic timestamp conversion into dates (introduced in
1.1.0
) has been reverted. All date fields returned from the server remain as UTC timestamps.The reason is that date fields on tasks contain a time component and converting them into date strings was erasing the time, resulting in a value that does not match the database.
Note: the server supports setting date fields using a date string like
2022-04-05
. You may use this if you prefer but the server will always return a timestamp.Note: we provide utility functions for easily converting dates from/to timestamps expected by the Projectal server. See:
projectal.date_from_timestamp()
,projectal.timestamp_from_date()
, andprojectal.timestamp_from_datetime()
.
Entity link methods now automatically update the entity's cached list of links. E.g: a task fetched with staff links will have
task['staffList'] = [Staff1,Staff2]
. Before, doing atask.link_staff(staff)
did not modify the list to reflect the addition. Now, it will turn into[Staff1,Staff2,Staff3]
. The same applies for update and delete.This allows you to modify links and continue working with that object without having to fetch it again to obtain the most recent link data. Be aware that if you acquire the object without requesting the link data as well (e.g:
projectal.Task.get(id, links='STAFF')
), these lists will not accurately reflect what's in the database, only the changes made while the object is held.Support new
applicationId
property on login. Set with:api_application_id
. The application ID is sent back to you in webhooks so you know which application was the source of the event (and you can choose to filter them accordingly).Added
Entity.set_readonly()
to allow setting values on entities that will not be sent over to the server when updating/saving the entity.The main use case for this is to populate cached entities which you have just created with values you already know about. This is mainly a workaround for the limitation of the server not sending the full object back after creating it, resulting in the client needing to fetch the object in full again if it needs some of the fields set by the server after creation.
Additionally, some read-only fields will generate an error on the server if included in the update request. This method lets you set these values on newly created objects without triggering this error.
A common example is setting the
projectRef
of a task you just created.
1.1.1
- Add support for 'profiles' API. Profiles are a type of key-value storage that target any entity. Not currently documented.
- Fix handling error message parsing in ProjectalException for batch create operation
- Add
Task.update_order()
to set task order - Return empty list when GETing empty list instead of failing (no request to server)
- Expose the timestamp returned by requests that modify the database. Use
projectal.request_timestamp
to get the value of the most recent request (None if no timestamp in response)
1.1.0
- Minimum Projectal version is now 1.9.4.
Breaking changes:
- Entity
list()
now returns a list of UUIDs instead of full objects. You may provide anexpand
parameter to restore the previous behavior:Entity.list(expand=True)
. This change is made for performance reasons where you may have thousands of tasks and getting them all may time out. For those cases, we suggest writing a query to filter down to only the tasks and fields you need. Company.get_master_company()
has been renamed toCompany.get_primary_company()
to match the server.- The following date fields are converted into date strings upon fetch:
startTime
,closeTime
,scheduleStart
,scheduleFinish
. These fields are added or updated using date strings (like2022-03-02
), but the server returns timestamps (e.g: 1646006400000) upon fetch, which is confusing. This change ensures they are always date strings for consistency.
Other changes:
- When updating an entity, only the fields that have changed are sent to the server. When updating a list of entities, unmodified entities are not sent to the server at all. This dramatically reduces the payload size and should speed things up.
- When fetching entities, entity links are now typed as well. E.g.
project['rebateList']
contains a list ofRebate
instead ofdict
. - Added
date_from_timestamp()
andtimestamp_from_date()
functions to help with converting to/from dates and Projectal timestamps. - Entity history now uses
desc
by default (index 0 is newest) - Added
Project.tasks()
to list all task UUIDs within a project.
1.0.3
- Fix another case of automatic JWT refresh not working
1.0.2
- Entity instances can
save()
ordelete()
on themselves - Fix broken
dict
methods (get()
andupdate()
) when called from Entity instances - Fix automatic JWT refresh only working in some cases
1.0.1
- Added
list()
function for all entities - Added search functions for all entities (match-, search, query)
- Added
Company.get_master_company()
- Fixed adding template tasks
1""" 2A python client for the [Projectal API](https://projectal.com/docs/latest). 3 4## Getting started 5 6``` 7import projectal 8import os 9 10# Supply your Projectal server URL and account credentials 11projectal.api_base = 'https://yourcompany.projectal.com' 12projectal.api_username = os.environ.get('PROJECTAL_USERNAME') 13projectal.api_password = os.environ.get('PROJECTAL_PASSWORD') 14 15# Test communication with server 16status = projectal.status() 17 18# Test account credentials 19projectal.login() 20details = projectal.auth_details() 21``` 22 23---- 24 25## Changelog 26 27### 4.3.1 28- Fixed typo in "Getting started" example. 29- Fixed typo in 4.3.0 Changelog. 30 31### 4.3.0 32 33**Breaking changes:** 34 35- Added "PREDECESSOR_TASK" option when fetching projectal.Task with links 36- Predecessor tasks will be returned as a list of tasks under the taskList attribute 37- This attribute name is different to what you would see when using the REST API directly 38 (planList). This change was necessary to allow for directly manipulating 39 the list of links and then saving the task entity to commit any changes, 40 since the REST API is expecting a different key for linking calls (taskList). 41- Existing Predecessor Task linking methods were also updated to match the new linking functionality. 42 They now work as a reverse linker, automatically inverting the link relationship between 43 the task entities. This more closely matches what you would expect to see based on the Web UI. 44 I.e. When previously calling `some_task.link_predecessor_task(another_task)`, 45 some_task would be set as a predecessor for another_task instead of the other way around. 46 Now another_task would be set as the predecessor for some_task. 47 48### 4.2.2 49- `projectal.User.current_user_permissions()` fixed incorrect query. 50- `projectal.Webhook.list()` default limit increased to 1000. 51 52### 4.2.1 53- Added classes allowing for the management of dynamic enums. The user must have the "List Management" 54 permission to update enums. 55 56 New classes: 57 - `projectal.CompanyTypes` 58 - `projectal.SkillLevels` 59 - `projectal.StaffTypes` 60 - `projectal.PriorityLevels` 61 - `projectal.ComplexityLevels` 62 - `projectal.CurrencyList` 63 64 The current enum can be retrieved with get(), and updated with set(). 65 For example, to return the current SkillLevels enum: 66 67 ``` 68 projectal.SkillLevels.get() 69 ``` 70 71 For each enum the entire list of key value pairs must be provided when calling set(), 72 any existing values that are omitted from the dictionary will be removed, 73 and any additional values will be added. 74 75 To update the SkillLevels enum with a new value: 76 77 ``` 78 new_value_added = { 79 "Senior": 10, 80 "Mid": 20, 81 "Junior": 30, 82 # new SkillLevel value "Beginner" 83 "Beginner": 40, 84 } 85 projectal.SkillLevels.set(new_value_added) 86 ``` 87 88 To change the name of a value, set a new key name for the original value: 89 90 ``` 91 updated_value_name = { 92 # changing "Senior" SkillLevel to "Expert" 93 "Expert": 10, 94 "Mid": 20, 95 "Junior": 30, 96 } 97 projectal.SkillLevels.set(updated_value_name) 98 ``` 99 100 To remove an existing value, call set on a dictionary with that value removed: 101 102 ``` 103 value_removed = { 104 "Senior": 10, 105 "Mid": 20, 106 # "Junior" SkillLevel removed 107 } 108 projectal.SkillLevels.set(new_value_added) 109 ``` 110 111 Updating the CurrencyList works differently to the other enums, since the 112 names of values must match the alphabetic currency code and the value must 113 match the numeric currency code. 114 This will cause an exception if you try to change the name for any values. 115 116 Adding a new currency: 117 118 ``` 119 new_currency_added = { 120 "AED": 784 121 ... 122 # rest of the existing currencies 123 ... 124 # new currency to add with the alphabetic and numeric code 125 "ZWL": 932, 126 } 127 projectal.CurrencyList.set(new_currency_added) 128 ``` 129 130 Removing an existing currency requires you to provide the numeric code for 131 the currency as a negative value. 132 133 ``` 134 currency_removed = { 135 # this currency will be removed 136 "AED": -784 137 ... 138 # rest of the existing currencies 139 ... 140 } 141 projectal.CurrencyList.set(currency_removed) 142 ``` 143 144### 4.2.0 145Version 4.2.0 accompanies the release of Projectal 4.1.0 146 147- Minimum Projectal version is now 4.1.0. 148 149- Changed order of applying link types when an entity is initialized, 150prevents a type error with reverse linking in certain situations. 151 152- `projectal.Task.reset_duration()` now supports adjustments with multi day calendar exceptions. 153 154- `projectal.Task.reset_duration()` location working days override base exceptions. 155 156- `projectal.TaskTemplate.list()` fixed incorrect query when using inherited method. 157 158### 4.1.0 159- DateLimit.Max enum value changed from "9999-12-31" to "3000-01-01". This reflects changes to the Projectal 160backend that defines this as the maximum allowable date value. The front end typically considers this value as 161equivalent with having no end date. 162 163- Updated requirements.txt version for requests package 164 165- Minimum Projectal version is now 4.0.40 166 167### 4.0.3 168- When a dict object is passed to the update class method, it will be converted to the corresponding Entity type. 169 Allows for proper handling of keys that require being treated as links. 170 171### 4.0.2 172- Booking entity is now fetched with project field and either staff or resource field. 173 174- Added missing link methods for 'Booking' entity (Note, File) 175 176- Added missing link methods for 'Activity' entity (Booking, Note, File, Rebate) 177 178- Reduced maximum number of link methods to 100 for a single batch request to prevent timeouts 179under heavy load. 180 181### 4.0.1 182- Minimum Projectal version is now 4.0.0. 183 184### 4.0.0 185 186Version 4.0.0 accompanies the release of Projectal 4.0. 187 188- Added the `Activity` entity, new in Projectal 4.0. 189 190- Added the `Booking` entity, new in Projectal 4.0. 191 192### 3.1.1 193- Link requests generated by 'projectal.Entity.create()' and 'projectal.Entity.update()' are now 194 executed in batches. This is enabled by default with the 'batch_linking=True' parameter and can 195 be disabled to execute each link request individually. It is recommended to leave this parameter 196 enabled as this can greatly reduce the number of network requests. 197 198### 3.1.0 199- Minimum Projectal version is now 3.1.5. 200 201- Added `projectal.Webhook.list_events()`. See API doc for details on how to use. 202 203- Added `deleted_at` parameter to `projectal.Entity.get()`. This value should be a UTC timestamp 204 from a webhook delete event. 205 206- Added `projectal.ldap_sync()` to initiate a user sync with the LDAP/AD service configured in 207 the Projectal server settings. 208 209- Enhanced output of `projectal.Entity.changes()` function when reporting link changes. 210 It no longer dumps the entire before-and-after list with the full content of each linked entity. 211 Now reports three lists: `added`, `updated`, `removed`. Entities within the `updated` list 212 follow the same `old` vs `new` dictionary model for the data attributes within them. E.g: 213 214 ``` 215 resourceList: [ 216 'added': [], 217 'updated': [ 218 {'uuId': '14eb4c31-0f92-49d1-8b4d-507ab939003e', 'resourceLink': {'utilization': {'old': 0.1, 'new': 0.9}}}, 219 ], 220 'removed': [] 221 ] 222 ``` 223 This should result in slimmer logs that are much easier to understand as the changes are 224 clearly indicated. 225 226### 3.0.2 227- Added `projectal.Entity.get_link_definitions()`. Exposes entity link definition dictionary. 228 Consumers can inspect which links an Entity knows about and their internal settings. 229 Link definitions that appear here are the links valid for `links=[]` parameters. 230 231### 3.0.1 232- Fixed fetching project with links=['task'] not being available. 233 234- Improved Permission.list(). Now returns a dict with the permission name as 235 key with Permission objects as the value (instead of list of uuIds). 236 237- Added a way to use the aliasing feature of the API (new in Projectal 3.0). 238Set `projectal.api_alias = 'uuid'` to the UUID of a User object and all 239requests made will be done as that user. Restore this value to None to resume 240normal operation. (Some rules and limitations apply. See API for more details.) 241 242- Added complete support for the Tags entity (including linkers). 243 244### 3.0 245 246Version 3.0 accompanies the release of Projectal 3.0. 247 248**Breaking changes**: 249 250- The `links` parameter on `Entity` functions now consumes a list of entity 251 names instead of a comma-separated string. For example: 252 253 ``` 254 # Before: 255 projectal.Staff.get('<uuid>', links='skill,location') # No longer valid 256 # Now: 257 projectal.Staff.get('<uuid>', links=['skill', 'location']) 258 ``` 259 260- The `projectal.enums.SkillLevel` enum has had all values renamed to match the new values 261 used in Projectal (Junior, Mid, Senior). This includes the properties on 262 Skill entities indicating work time for auto-scheduling (now `juniorLevel`, 263 `midLevel`, `seniorLevel`). 264 265**Other changes**: 266 267- Working with entity links has changed in this release. The previous methods 268 are still available and continue to work as before, but there is no need 269 to interact with the `projectal.linkers` methods yourself anymore. 270 271 You can now modify the list of links within an entity and save the entity 272 directly. The library will automatically determine how the links have been 273 modified and issue the correct linker methods on your behalf. E.g., 274 you can now do: 275 276 ``` 277 staff = projectal.Staff.get('<uuid>', links=['skill']) 278 staff['firstName'] = "New name" # Field update 279 staff['skillList'] = [skill1, skill2, skill3] # Link update 280 staff.save() # Both changes are saved 281 282 task = projectal.Task.get('<uuid>', links=['stage']) 283 task['stage'] = stage1 # Uses a single object instead of list 284 task.save() 285 ``` 286 287 See `examples/linking.py` for a more complete demonstration of linking 288 capabilities and limitations. 289 290- Linkers (`projectal.linkers`) can now be given a list of Entities (of one 291 type) to link/unlink/relink in bulk. E.g: 292 ``` 293 staff.unlink_skill(skill1) # Before 294 staff.unlink_skill([skill1, skill2, skill3]) # This works now too 295 ``` 296 297- Linkers now strip the payload to only the required fields instead of passing 298 on the entire Entity object. This cuts down on network traffic significantly. 299 300- Linkers now also work in reverse. The Projectal server currently only supports 301 linking entities in one direction (e.g., Company to Staff), which often means 302 writing something like: 303 ``` 304 staff.link_location(location) 305 company.link_staff(staff) 306 ``` 307 The change in direction is not very intuitive and would require you to constantly 308 verify which direction is the one available to you in the documentation. 309 310 Reverse linkers hide this from you and figure out the direction of the relationship 311 for you behind the scenes. So now this is possible, even though the API doesn't 312 strictly support it: 313 ``` 314 staff.link_location(location) 315 staff.link_company(company) 316 ``` 317 Caveat: the documentation for Staff will not list Company links. You will still 318 have to look up the Company documentation for the link description. 319 320- Requesting entity links with the `links=` parameter will now always ensure the 321 link field (e.g., `taskList`) exists in the result, even if there are no links. 322 The server may not always return a value, but we can use a default value ([] for 323 lists, None for dicts). 324 325- Added a `Permission` entity to correctly type Permissions in responses. 326 327- Added a `Tag` entity, new in Projectal 3.0. 328 329- Added `links` parameter to `Company.get_primary_company()` 330 331- `Department.tree()`: now consumes a `holder` Entity object instead 332 of a uuId. 333 334- `Department.tree()`: added `generic_staff` parameter, new in 335 Projectal 3.0. 336 337- Don't break on trailing slash in Projectal URL 338 339- When creating tasks, populate the `projectRef` and `parent` fields in the 340 returned Task object. 341 342- Added convenience functions for matching on fields where you only want 343 one result (e.g match_one()) which return the first match found. 344 345- Update the entity `history()` method for Projectal 3.0. Some new parameters 346 allow you to restrict the history to a particular range or to get only the 347 changes for a webhook timestamp. 348 349- Entity objects can call `.history()` on themselves. 350 351- The library now keeps a reference to the User account that is currently logged 352 in and using the API: `projectal.api_auth_details`. 353 354**Known issues**: 355- You cannot save changes to Notes or Calendars via their holding entity. You 356 must save the changes on the Note or Calendar directly. To illustrate: 357 ``` 358 staff = projectal.Staff.get(<uuid>, links=['calendar']) 359 calendar = staff['calendarList'][0] 360 calendar['name'] = 'Calendar 2' 361 362 # Cannot do this - will not pick up the changes 363 staff.save() 364 365 # You must do this for now 366 calendar.save() 367 ``` 368 This will be resolved in a future release. 369 370- When creating Notes, the `created` and `modified` values may differ by 371 1ms in the object you have a reference to compared to what is actually 372 stored in the database. 373 374- Duration calculation is not precise yet (mentioned in 2.1.0) 375 376### 2.1.0 377**Breaking changes**: 378- Getting location calendar is now done on an instance instead of class. So 379 `projectal.Location.calendar(uuid)` is now simply `location.calendar()` 380- The `CompanyType.Master` enum has been replaced with `CompanyType.Primary`. 381 This was a leftover reference to the Master Company which was renamed in 382 Projectal several versions ago. 383 384**Other changes**: 385- Date conversion functions return None when given None or empty string 386- Added `Task.reset_duration()` as a basic duration calculator for tasks. 387 This is a work-in-progress and will be gradually improved. The duration 388 calculator takes into consideration the location to remove non-work 389 days from the estimate of working duration. It currently does not work 390 for the time component or `isWorking=True` exceptions. 391- Change detection in `Entity.changes()` now excludes cases where the 392 server has no value and the new value is None. Saving this change has 393 no effect and would always detect a change until a non-None value is 394 set, which is noisy and generates more network activity. 395 396### 2.0.3 397- Better support for calendars. 398 - Distinguish between calendar containers ("Calendar") and the 399 calendar items within them ("CalendarItem"). 400 - Allow CalendarItems to be saved directly. E.G item.save() 401- Fix 'holder' parameter in contact/staff/location/task_template not 402 permitting object type. Now consumes uuId or object to match rest of 403 the library. 404- `Entity.changes()` has been extended with an `old=True` flag. When 405 this flag is true, the set of changes will now return both the original 406 and the new values. E.g. 407``` 408task.changes() 409# {'name': 'current'} 410task.changes(old=True) 411# {'name': {'old': 'original', 'new': 'current'}} 412``` 413- Fixed entity link cache causing errors when deleting a link from an entity 414 which has not been fetched with links (deleting from empty list). 415 416### 2.0.2 417- Fixed updating Webhook entities 418 419### 2.0.1 420- Fixed application ID not being used correctly. 421 422### 2.0.0 423- Version 2.0 accompanies the release of Projectal 2.0. There are no major changes 424 since the previous release. 425- Expose `Entity.changes()` function. It returns a list of fields on an entity that 426 have changed since fetching it. These are the changes that will be sent over to the 427 server when an update request is made. 428- Added missing 'packaging' dependency to requirements. 429 430### 1.2.0 431 432**Breaking changes**: 433 434- Renamed `request_timestamp` to `response_timestamp` to better reflect its purpose. 435- Automatic timestamp conversion into dates (introduced in `1.1.0`) has been reverted. 436 All date fields returned from the server remain as UTC timestamps. 437 438 The reason is that date fields on tasks contain a time component and converting them 439 into date strings was erasing the time, resulting in a value that does not match 440 the database. 441 442 Note: the server supports setting date fields using a date string like `2022-04-05`. 443 You may use this if you prefer but the server will always return a timestamp. 444 445 Note: we provide utility functions for easily converting dates from/to 446 timestamps expected by the Projectal server. See: 447 `projectal.date_from_timestamp()`,`projectal.timestamp_from_date()`, and 448 `projectal.timestamp_from_datetime()`. 449 450**Other changes**: 451- Implement request chunking - for methods that consume a list of entities, we now 452 automatically batch them up into multiple requests to prevent timeouts on really 453 large request. Values are configurable through 454 `projectal.chunk_size_read` and `projectal.chunk_size_write`. 455 Default values: Read: 1000 items. Write: 200 items. 456- Added profile get/set functions on entities for easier use. Now you only need to supply 457 the key and the data. E.g: 458 459``` 460key = 'hr_connector' 461data = {'staff_source': 'company_z'} 462task.profile_set(key, data) 463``` 464 465- Entity link methods now automatically update the entity's cached list of links. E.g: 466 a task fetched with staff links will have `task['staffList'] = [Staff1,Staff2]`. 467 Before, doing a `task.link_staff(staff)` did not modify the list to reflect the 468 addition. Now, it will turn into `[Staff1,Staff2,Staff3]`. The same applies for update 469 and delete. 470 471 This allows you to modify links and continue working with that object without having 472 to fetch it again to obtain the most recent link data. Be aware that if you acquire 473 the object without requesting the link data as well 474 (e.g: `projectal.Task.get(id, links='STAFF')`), 475 these lists will not accurately reflect what's in the database, only the changes made 476 while the object is held. 477 478- Support new `applicationId` property on login. Set with: `projectal.api_application_id`. 479 The application ID is sent back to you in webhooks so you know which application was 480 the source of the event (and you can choose to filter them accordingly). 481- Added `Entity.set_readonly()` to allow setting values on entities that will not 482 be sent over to the server when updating/saving the entity. 483 484 The main use case for this is to populate cached entities which you have just created 485 with values you already know about. This is mainly a workaround for the limitation of 486 the server not sending the full object back after creating it, resulting in the client 487 needing to fetch the object in full again if it needs some of the fields set by the 488 server after creation. 489 490 Additionally, some read-only fields will generate an error on the server if 491 included in the update request. This method lets you set these values on newly 492 created objects without triggering this error. 493 494 A common example is setting the `projectRef` of a task you just created. 495 496 497### 1.1.1 498- Add support for 'profiles' API. Profiles are a type of key-value storage that target 499 any entity. Not currently documented. 500- Fix handling error message parsing in ProjectalException for batch create operation 501- Add `Task.update_order()` to set task order 502- Return empty list when GETing empty list instead of failing (no request to server) 503- Expose the timestamp returned by requests that modify the database. Use 504 `projectal.request_timestamp` to get the value of the most recent request (None 505 if no timestamp in response) 506 507### 1.1.0 508- Minimum Projectal version is now 1.9.4. 509 510**Breaking changes**: 511- Entity `list()` now returns a list of UUIDs instead of full objects. You may provide 512 an `expand` parameter to restore the previous behavior: `Entity.list(expand=True)`. 513 This change is made for performance reasons where you may have thousands of tasks 514 and getting them all may time out. For those cases, we suggest writing a query to filter 515 down to only the tasks and fields you need. 516- `Company.get_master_company()` has been renamed to `Company.get_primary_company()` 517 to match the server. 518- The following date fields are converted into date strings upon fetch: 519 `startTime`, `closeTime`, `scheduleStart`, `scheduleFinish`. 520 These fields are added or updated using date strings (like `2022-03-02`), but the 521 server returns timestamps (e.g: 1646006400000) upon fetch, which is confusing. This 522 change ensures they are always date strings for consistency. 523 524**Other changes**: 525- When updating an entity, only the fields that have changed are sent to the server. When 526 updating a list of entities, unmodified entities are not sent to the server at all. This 527 dramatically reduces the payload size and should speed things up. 528- When fetching entities, entity links are now typed as well. E.g. `project['rebateList']` 529 contains a list of `Rebate` instead of `dict`. 530- Added `date_from_timestamp()` and `timestamp_from_date()` functions to help with 531 converting to/from dates and Projectal timestamps. 532- Entity history now uses `desc` by default (index 0 is newest) 533- Added `Project.tasks()` to list all task UUIDs within a project. 534 535### 1.0.3 536- Fix another case of automatic JWT refresh not working 537 538### 1.0.2 539- Entity instances can `save()` or `delete()` on themselves 540- Fix broken `dict` methods (`get()` and `update()`) when called from Entity instances 541- Fix automatic JWT refresh only working in some cases 542 543### 1.0.1 544- Added `list()` function for all entities 545- Added search functions for all entities (match-, search, query) 546- Added `Company.get_master_company()` 547- Fixed adding template tasks 548 549""" 550import logging 551import os 552 553from projectal.entities import * 554from projectal.dynamic_enums import * 555from .api import * 556from . import profile 557 558api_base = os.getenv("PROJECTAL_URL") 559api_username = os.getenv("PROJECTAL_USERNAME") 560api_password = os.getenv("PROJECTAL_PASSWORD") 561api_application_id = None 562api_auth_details = None 563api_alias = None 564cookies = None 565chunk_size_read = 1000 566chunk_size_write = 200 567 568# Records the timestamp generated by the last request (database 569# event time). These are reported on add or updates; if there is 570# no timestamp in the response, this is set to None. 571response_timestamp = None 572 573 574# The minimum version number of the Projectal instance that this 575# API client targets. Lower versions are not supported and will 576# raise an exception. 577MIN_PROJECTAL_VERSION = "4.0.40" 578 579__verify = True 580 581logging.getLogger("projectal-api-client").addHandler(logging.NullHandler())