ProjectManagerSdk 11.1.2053__tar.gz

projectmanagersdk-11.1.2053/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Upload Python Package
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    # - name: Run Pyre
+    #   run: |
+    #     python -m pip install pyre-check
+    #     pyre --source-directory src check
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      if: github.ref == 'refs/heads/main' && github.event_name == 'push' 
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

projectmanagersdk-11.1.2053/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

projectmanagersdk-11.1.2053/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 projectmgr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

projectmanagersdk-11.1.2053/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: ProjectManagerSdk
+Version: 11.1.2053
+Summary: Software development kit for the ProjectManager.com API for Python
+Project-URL: Homepage, https://github.com/projectmgr/projectmanager-sdk-python
+Project-URL: Bug Tracker, https://github.com/projectmgr/projectmanager-sdk-python/issues
+Author-email: "ProjectManager.com" <support@projectmanager.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# projectmanager-sdk-python
+ProjectManager.com SDK for Python

projectmanagersdk-11.1.2053/README.md

@@ -0,0 +1,2 @@
+# projectmanager-sdk-python
+ProjectManager.com SDK for Python

projectmanagersdk-11.1.2053/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "ProjectManagerSdk"
+version = "11.1.2053"
+authors = [
+    { name = "ProjectManager.com", email = "support@projectmanager.com" }
+]
+description = "Software development kit for the ProjectManager.com API for Python"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/projectmgr/projectmanager-sdk-python"
+"Bug Tracker" = "https://github.com/projectmgr/projectmanager-sdk-python/issues"
+
+[build-system]
+requires = ["hatchling", "find", "requests"]
+build-backend = "hatchling.build"

projectmanagersdk-11.1.2053/src/ProjectManagerSdk/clients/apikeyclient.py

@@ -0,0 +1,162 @@
+#
+# ProjectManager API for Python
+#
+# (c) 2023-2023 ProjectManager.com, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     ProjectManager.com <support@projectmanager.com>
+# @copyright  2023-2023 ProjectManager.com, Inc.
+# @link       https://github.com/projectmgr/projectmanager-sdk-python
+#
+
+from models.apikeycreatedto import ApiKeyCreateDto
+from models.apikeydto import ApiKeyDto
+from models.astroresult import AstroResult
+import json
+
+class ApiKeyClient:
+    """
+    API methods related to ApiKey
+    """
+    from projectmanagerclient import ProjectManagerClient
+
+    def __init__(self, client: ProjectManagerClient):
+        self.client = client
+
+    def create_api_key(self, body: ApiKeyCreateDto) -> AstroResult[ApiKeyDto]:
+        """
+        Creates a new API key for the current user with the specified
+        options.
+
+        An API key is a credential that you can use to make REST v4 API
+        calls for ProjectManager.com. When you create a new API key,
+        that API key is only visible in the response JSON for the
+        `CreateApiKey` method. If you do not preserve this information,
+        it cannot be recreated.
+
+        Some best practices for working with API keys: * An API key is
+        valid for a two year period after it is created. We encourage
+        you to rotate your API keys regularly according to your
+        company's security policies. * You should create separate API
+        keys for each system that works with your API. If that API key
+        is exposed or if that program needs to be shut down, you can
+        revoke that one key and reissue it. * An API key is tied to the
+        workspace that created it. A single API key can only interact
+        with one workspace.
+
+        Parameters
+        ----------
+        body : ApiKeyCreateDto
+            Options for the API key to create
+        """
+        path = "/api/data/api-keys"
+        queryParams = {}
+        result = self.client.send_request("POST", path, body, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, ApiKeyDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def list_api_keys(self) -> AstroResult[list[ApiKeyDto]]:
+        """
+        Returns a list of all API keys within the current workspace.
+
+        An API key is a credential that you can use to make REST v4 API
+        calls for ProjectManager.com. When you create a new API key,
+        that API key is only visible in the response JSON for the
+        `CreateApiKey` method. If you do not preserve this information,
+        it cannot be recreated.
+
+        Some best practices for working with API keys: * An API key is
+        valid for a two year period after it is created. We encourage
+        you to rotate your API keys regularly according to your
+        company's security policies. * You should create separate API
+        keys for each system that works with your API. If that API key
+        is exposed or if that program needs to be shut down, you can
+        revoke that one key and reissue it. * An API key is tied to the
+        workspace that created it. A single API key can only interact
+        with one workspace.
+
+        Parameters
+        ----------
+        """
+        path = "/api/data/api-keys"
+        queryParams = {}
+        result = self.client.send_request("GET", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            data = []
+            for dict in json.loads(result.content)['data']:
+                data.append(ApiKeyDto(**dict))
+            return AstroResult(None, True, False, result.status_code, data)
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def revoke_all_api_keys(self) -> AstroResult[object]:
+        """
+        This API call revokes all existing API keys in given workspace.
+        No existing keys will continue to work after this call
+        completes. We strongly encourage you to revoke a single API key
+        at a time; this method should only be used if you need to
+        rapidly halt access to your product for automated systems.
+
+        An API key is a credential that you can use to make REST v4 API
+        calls for ProjectManager.com. When you create a new API key,
+        that API key is only visible in the response JSON for the
+        `CreateApiKey` method. If you do not preserve this information,
+        it cannot be recreated.
+
+        Some best practices for working with API keys: * An API key is
+        valid for a two year period after it is created. We encourage
+        you to rotate your API keys regularly according to your
+        company's security policies. * You should create separate API
+        keys for each system that works with your API. If that API key
+        is exposed or if that program needs to be shut down, you can
+        revoke that one key and reissue it. * An API key is tied to the
+        workspace that created it. A single API key can only interact
+        with one workspace.
+
+        Parameters
+        ----------
+        """
+        path = "/api/data/api-keys/revoke-all"
+        queryParams = {}
+        result = self.client.send_request("DELETE", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, object(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def revoke_api_key(self, id: str) -> AstroResult[object]:
+        """
+        Revokes a single API key in the current workspace.
+
+        An API key is a credential that you can use to make REST v4 API
+        calls for ProjectManager.com. When you create a new API key,
+        that API key is only visible in the response JSON for the
+        `CreateApiKey` method. If you do not preserve this information,
+        it cannot be recreated.
+
+        Some best practices for working with API keys: * An API key is
+        valid for a two year period after it is created. We encourage
+        you to rotate your API keys regularly according to your
+        company's security policies. * You should create separate API
+        keys for each system that works with your API. If that API key
+        is exposed or if that program needs to be shut down, you can
+        revoke that one key and reissue it. * An API key is tied to the
+        workspace that created it. A single API key can only interact
+        with one workspace.
+
+        Parameters
+        ----------
+        id : str
+            The unique identifier of the API key to revoke
+        """
+        path = f"/api/data/api-keys/{id}/revoke"
+        queryParams = {}
+        result = self.client.send_request("DELETE", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, object(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)

projectmanagersdk-11.1.2053/src/ProjectManagerSdk/clients/changesetclient.py

@@ -0,0 +1,93 @@
+#
+# ProjectManager API for Python
+#
+# (c) 2023-2023 ProjectManager.com, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     ProjectManager.com <support@projectmanager.com>
+# @copyright  2023-2023 ProjectManager.com, Inc.
+# @link       https://github.com/projectmgr/projectmanager-sdk-python
+#
+
+from models.astroresult import AstroResult
+from models.changesetgetresponsedto import ChangesetGetResponseDto
+import json
+
+class ChangesetClient:
+    """
+    API methods related to Changeset
+    """
+    from projectmanagerclient import ProjectManagerClient
+
+    def __init__(self, client: ProjectManagerClient):
+        self.client = client
+
+    def retrieve_changeset(self, changeSetId: str) -> AstroResult[ChangesetGetResponseDto]:
+        """
+        Retrieve a Changeset by its unique ID.
+
+        A Changeset is an individual edit that has been made to a
+        project. Since multiple users can edit a project at the same
+        time, individual Changesets are applied in a sequential fashion.
+        If a Changeset causes a conflict or cannot be applied, it will
+        be rejected. You can examine a Changeset to determine its
+        conflict resolution status.
+
+        When checking the status of a Changeset, you can call either
+        RetrieveChangeset or RetrieveCompletedChangeset. Using
+        RetrieveChangeset will give you the immediate status of the
+        Changeset. Using RetrieveCompletedChangeset will delay the
+        response until the Changeset has finished processing.
+
+        Parameters
+        ----------
+        changeSetId : str
+            The unique ID number of the Changeset to retrieve
+        """
+        path = f"/api/data/changesets/{changeSetId}"
+        queryParams = {}
+        result = self.client.send_request("GET", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, ChangesetGetResponseDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def retrieve_completed_changeset(self, changeSetId: str) -> AstroResult[ChangesetGetResponseDto]:
+        """
+        Retrieve a Changeset by its unique ID. This endpoint waits for
+        the Changeset to complete its processing prior to returning a
+        result.
+
+        A Changeset is an individual edit that has been made to a
+        project. Since multiple users can edit a project at the same
+        time, individual Changesets are applied in a sequential fashion.
+        If a Changeset causes a conflict or cannot be applied, it will
+        be rejected. You can examine a Changeset to determine its
+        conflict resolution status.
+
+        When checking the status of a Changeset, you can call either
+        RetrieveChangeset or RetrieveCompletedChangeset. Using
+        RetrieveChangeset will give you the immediate status of the
+        Changeset. Using RetrieveCompletedChangeset will delay the
+        response until the Changeset has finished processing.
+
+        Although most Changesets complete instantly, some Changesets may
+        need additional time to complete. If the Changeset cannot be
+        processed within a reasonable length of time, this API call may
+        fail. If this API fails, it will return a status error
+        indicating the Changeset is still being processed.
+
+        Parameters
+        ----------
+        changeSetId : str
+            The unique ID number of the Changeset to retrieve
+        """
+        path = f"/api/data/changesets/{changeSetId}/poll"
+        queryParams = {}
+        result = self.client.send_request("GET", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, ChangesetGetResponseDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)

projectmanagersdk-11.1.2053/src/ProjectManagerSdk/clients/dashboardclient.py

@@ -0,0 +1,60 @@
+#
+# ProjectManager API for Python
+#
+# (c) 2023-2023 ProjectManager.com, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     ProjectManager.com <support@projectmanager.com>
+# @copyright  2023-2023 ProjectManager.com, Inc.
+# @link       https://github.com/projectmgr/projectmanager-sdk-python
+#
+
+from models.astroresult import AstroResult
+from models.dashboardsettingcreatedto import DashboardSettingCreateDto
+from models.dashboardsettingdto import DashboardSettingDto
+import json
+
+class DashboardClient:
+    """
+    API methods related to Dashboard
+    """
+    from projectmanagerclient import ProjectManagerClient
+
+    def __init__(self, client: ProjectManagerClient):
+        self.client = client
+
+    def retrieve_dashboard_user_settings(self, type: str) -> AstroResult[DashboardSettingDto]:
+        """
+        Returns user dashboard settings
+
+        Parameters
+        ----------
+        type : str
+            The dashboard type that is not custom
+        """
+        path = f"/api/data/dashboards/settings/{type}"
+        queryParams = {}
+        result = self.client.send_request("GET", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, DashboardSettingDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def create_or_update_user_dashboard_settings(self, body: DashboardSettingCreateDto) -> AstroResult[DashboardSettingDto]:
+        """
+        Create or Update User Dashboard Settings
+
+        Parameters
+        ----------
+        body : DashboardSettingCreateDto
+            User dashboard settings object
+        """
+        path = "/api/data/dashboards/settings"
+        queryParams = {}
+        result = self.client.send_request("POST", path, body, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, DashboardSettingDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)

projectmanagersdk-11.1.2053/src/ProjectManagerSdk/clients/discussionclient.py

@@ -0,0 +1,73 @@
+#
+# ProjectManager API for Python
+#
+# (c) 2023-2023 ProjectManager.com, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     ProjectManager.com <support@projectmanager.com>
+# @copyright  2023-2023 ProjectManager.com, Inc.
+# @link       https://github.com/projectmgr/projectmanager-sdk-python
+#
+
+from models.astroresult import AstroResult
+from models.discussioncreatedto import DiscussionCreateDto
+from models.discussioncreateresponsedto import DiscussionCreateResponseDto
+from models.discussiondto import DiscussionDto
+import json
+
+class DiscussionClient:
+    """
+    API methods related to Discussion
+    """
+    from projectmanagerclient import ProjectManagerClient
+
+    def __init__(self, client: ProjectManagerClient):
+        self.client = client
+
+    def retrieve_task_comments(self, taskId: str) -> AstroResult[list[DiscussionDto]]:
+        """
+        Retrieve all comments written about a task
+
+        Parameters
+        ----------
+        taskId : str
+            The unique ID number of the task to retrieve comments
+        """
+        path = f"/api/data/tasks/{taskId}/discussions"
+        queryParams = {}
+        result = self.client.send_request("GET", path, None, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            data = []
+            for dict in json.loads(result.content)['data']:
+                data.append(DiscussionDto(**dict))
+            return AstroResult(None, True, False, result.status_code, data)
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)
+
+    def create_task_comments(self, taskId: str, body: DiscussionCreateDto) -> AstroResult[DiscussionCreateResponseDto]:
+        """
+        Adds a Markdown-formatted comment to a task.
+
+        Tasks can have discussions attached to them. These discussions
+        can include text with simple formatting. Discussion comments are
+        formatted using [Markdown](https://www.markdownguide.org/) and
+        users should be aware that HTML embedding is not permitted due
+        to the risk of cross-site attacks and other embedding
+        challenges.
+
+        Parameters
+        ----------
+        taskId : str
+            The unique ID number of the task being commented upon
+        body : DiscussionCreateDto
+            The Markdown-formatted text of the comment
+        """
+        path = f"/api/data/tasks/{taskId}/discussions"
+        queryParams = {}
+        result = self.client.send_request("POST", path, body, queryParams, None)
+        if result.status_code >= 200 and result.status_code < 300:
+            return AstroResult(None, True, False, result.status_code, DiscussionCreateResponseDto(**json.loads(result.content)['data']))
+        else:
+            return AstroResult(result.json(), False, True, result.status_code, None)