uipath 0.0.1__tar.gz → 1.0.0__tar.gz

uipath-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,40 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+          pip install -e .
+      
+      - name: Build docs
+        run: mkdocs build
+      
+      - name: Deploy docs
+        if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/'))
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          force_orphan: true
+          commit_message: 'docs: update documentation' 

uipath-1.0.0/.gitignore

@@ -0,0 +1,47 @@
+api_spec.json
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environment
+.env
+.venv
+env/
+venv/
+ENV/
+uipath-env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.coverage
+.pytest_cache/
+htmlcov/
+
+# Distribution
+dist/
+build/
+*.egg-info/ 

uipath-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Name
+
+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. 

uipath-1.0.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.2
+Name: uipath
+Version: 1.0.0
+Summary: A Python SDK for UiPath
+Home-page: https://github.com/christianblandford/uipath
+Author: Christian Blandford
+Author-email: christianblandford@me.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.8"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: flake8>=3.9; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# UiPath Python SDK
+
+A Python SDK for interacting with UiPath's APIs. This SDK provides a simple and intuitive way to automate UiPath operations programmatically.
+
+## Installation 
+
+```bash
+pip install uipath
+```
+
+## Quick Start
+
+```python
+from uipath.auth.authentication import UiPathAuth
+from uipath.client.api_client import UiPathClient
+from uipath.resources.robots import RobotsResource
+
+# Initialize authentication
+auth = UiPathAuth(
+    tenant_name="your_tenant",
+    client_id="your_client_id",
+    client_secret="your_client_secret"
+)
+
+# Create API client
+client = UiPathClient(auth)
+
+# Use the robots resource
+robots = RobotsResource(client)
+
+# List all robots
+all_robots = robots.list_robots()
+```
+
+## Features
+
+- Simple, intuitive interface for UiPath APIs
+- Authentication handling
+- Comprehensive error handling
+- Type hints for better IDE support
+- Resource classes for all major UiPath entities:
+  - Robots
+  - Jobs
+  - Processes
+  - Assets
+  - And more...
+
+## Authentication
+
+The SDK supports client credentials authentication. You'll need:
+- Tenant name
+- Client ID
+- Client secret
+
+You can obtain these credentials from your UiPath Orchestrator account under Admin → API Access.
+
+```python
+auth = UiPathAuth(
+    tenant_name="your_tenant",
+    client_id="your_client_id",
+    client_secret="your_client_secret",
+    scope="OR.Default"  # Optional, defaults to OR.Default
+)
+```
+
+## Usage Examples
+
+### Working with Robots
+
+```python
+# List all robots
+robots = RobotsResource(client)
+all_robots = robots.list_robots()
+
+# Get a specific robot
+robot = robots.get_robot(robot_id=123)
+
+# Create a new robot
+new_robot = robots.create_robot(
+    name="MyNewRobot",
+    machine_name="DESKTOP-123",
+    type="Unattended"
+)
+```
+
+### Error Handling
+
+The SDK provides custom exceptions for different types of errors:
+
+```python
+from uipath.exceptions.exceptions import AuthenticationError, ApiError
+
+try:
+    robots.get_robot(robot_id=999)
+except AuthenticationError as e:
+    print("Authentication failed:", e)
+except ApiError as e:
+    print("API request failed:", e)
+```
+
+## Configuration
+
+The SDK can be configured with custom endpoints and API versions:
+
+```python
+client = UiPathClient(
+    auth,
+    base_url="https://cloud.uipath.com",  # Custom base URL
+    api_version="v1"  # API version
+)
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you encounter any problems or have questions, please:
+1. Check the [documentation](docs/)
+2. Open an issue in the GitHub repository
+
+## Requirements
+
+- Python 3.7+
+- requests library
+
+## Disclaimer
+
+This is an unofficial SDK and is not affiliated with, maintained, authorized, endorsed, or sponsored by UiPath.

uipath-1.0.0/README.md

@@ -0,0 +1,140 @@
+# UiPath Python SDK
+
+A Python SDK for interacting with UiPath's APIs. This SDK provides a simple and intuitive way to automate UiPath operations programmatically.
+
+## Installation 
+
+```bash
+pip install uipath
+```
+
+## Quick Start
+
+```python
+from uipath.auth.authentication import UiPathAuth
+from uipath.client.api_client import UiPathClient
+from uipath.resources.robots import RobotsResource
+
+# Initialize authentication
+auth = UiPathAuth(
+    tenant_name="your_tenant",
+    client_id="your_client_id",
+    client_secret="your_client_secret"
+)
+
+# Create API client
+client = UiPathClient(auth)
+
+# Use the robots resource
+robots = RobotsResource(client)
+
+# List all robots
+all_robots = robots.list_robots()
+```
+
+## Features
+
+- Simple, intuitive interface for UiPath APIs
+- Authentication handling
+- Comprehensive error handling
+- Type hints for better IDE support
+- Resource classes for all major UiPath entities:
+  - Robots
+  - Jobs
+  - Processes
+  - Assets
+  - And more...
+
+## Authentication
+
+The SDK supports client credentials authentication. You'll need:
+- Tenant name
+- Client ID
+- Client secret
+
+You can obtain these credentials from your UiPath Orchestrator account under Admin → API Access.
+
+```python
+auth = UiPathAuth(
+    tenant_name="your_tenant",
+    client_id="your_client_id",
+    client_secret="your_client_secret",
+    scope="OR.Default"  # Optional, defaults to OR.Default
+)
+```
+
+## Usage Examples
+
+### Working with Robots
+
+```python
+# List all robots
+robots = RobotsResource(client)
+all_robots = robots.list_robots()
+
+# Get a specific robot
+robot = robots.get_robot(robot_id=123)
+
+# Create a new robot
+new_robot = robots.create_robot(
+    name="MyNewRobot",
+    machine_name="DESKTOP-123",
+    type="Unattended"
+)
+```
+
+### Error Handling
+
+The SDK provides custom exceptions for different types of errors:
+
+```python
+from uipath.exceptions.exceptions import AuthenticationError, ApiError
+
+try:
+    robots.get_robot(robot_id=999)
+except AuthenticationError as e:
+    print("Authentication failed:", e)
+except ApiError as e:
+    print("API request failed:", e)
+```
+
+## Configuration
+
+The SDK can be configured with custom endpoints and API versions:
+
+```python
+client = UiPathClient(
+    auth,
+    base_url="https://cloud.uipath.com",  # Custom base URL
+    api_version="v1"  # API version
+)
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you encounter any problems or have questions, please:
+1. Check the [documentation](docs/)
+2. Open an issue in the GitHub repository
+
+## Requirements
+
+- Python 3.7+
+- requests library
+
+## Disclaimer
+
+This is an unofficial SDK and is not affiliated with, maintained, authorized, endorsed, or sponsored by UiPath.

uipath-1.0.0/docs/index.md

@@ -0,0 +1,30 @@
+# UiPath Python SDK
+
+A Python SDK for interacting with the UiPath Orchestrator API.
+
+## Features
+
+- Complete API coverage for UiPath Orchestrator
+- Easy-to-use interface
+- Type hints for better IDE support
+- Comprehensive documentation
+- Examples for common use cases
+
+## Installation 
+
+```bash
+pip install uipath
+```
+
+## Quick Start
+
+```python
+from uipath import UiPathClient
+
+client = UiPathClient(
+    organization_id="your_organization_id",
+    tenant_id="your_tenant_id",
+    client_id="your_client_id",
+    client_secret="your_client_secret"
+)
+```

uipath-1.0.0/docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material
+mkdocs-autorefs
+mkdocstrings[python] 

uipath-1.0.0/mkdocs.yml

@@ -0,0 +1,58 @@
+site_name: UiPath Python SDK
+site_description: Python SDK for UiPath Orchestrator API
+repo_url: https://github.com/christianblandford/uipath
+repo_name: christianblandford/uipath
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.suggest
+    - search.highlight
+
+plugins:
+  - search
+  - autorefs
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [uipath]
+          options:
+            show_source: false
+            show_root_heading: true
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - API Reference:
+    - Client: api/client.md
+    - Resources:
+      - Assets: api/resources/assets.md
+      - Folders: api/resources/folders.md
+      - Jobs: api/resources/jobs.md
+      - Libraries: api/resources/libraries.md
+      - Machines: api/resources/machines.md
+      - Packages: api/resources/packages.md
+      - Processes: api/resources/processes.md
+      - Queues: api/resources/queues.md
+      - Releases: api/resources/releases.md
+      - Robots: api/resources/robots.md
+  - Examples: examples.md 

uipath-1.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 88
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3 

{uipath-0.0.1 → uipath-1.0.0}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

uipath-1.0.0/setup.py

@@ -0,0 +1,44 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="uipath",
+    version="1.0.0",
+    author="Christian Blandford",
+    author_email="christianblandford@me.com",
+    description="A Python SDK for UiPath",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/christianblandford/uipath",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ],
+    python_requires=">=3.7",
+    install_requires=[
+        "requests>=2.25.0",
+        "typing-extensions>=4.0.0;python_version<'3.8'",
+    ],
+    extras_require={
+        "dev": [
+            "pytest>=6.0",
+            "pytest-cov>=2.0",
+            "black>=22.0",
+            "isort>=5.0",
+            "mypy>=0.900",
+            "flake8>=3.9",
+        ],
+    }
+) 

uipath-1.0.0/uipath/__init__.py

@@ -0,0 +1,9 @@
+from uipath.__version__ import __version__
+from uipath.auth.authentication import UiPathAuth
+from uipath.client.api_client import UiPathClient
+
+__all__ = [
+    '__version__',
+    'UiPathAuth',
+    'UiPathClient',
+] 

uipath-1.0.0/uipath/__version__.py

@@ -0,0 +1,3 @@
+VERSION = (1, 0, 0)
+
+__version__ = '.'.join(map(str, VERSION)) 

uipath-1.0.0/uipath/auth/authentication.py

@@ -0,0 +1,53 @@
+import requests
+from typing import Optional, Dict
+
+class UiPathAuth:
+    def __init__(
+        self,
+        client_id: str,
+        client_secret: str,
+        scope: str = "OR.Assets",
+        tenant_name: Optional[str] = None,
+        organization_id: Optional[str] = None,
+        auth_url: str = "https://cloud.uipath.com/identity_/connect/token"
+    ):
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.scope = scope
+        self.tenant_name = tenant_name
+        self.organization_id = organization_id
+        self.auth_url = auth_url
+        self._token = None
+
+    def get_token(self) -> str:
+        """Get OAuth token, refreshing if necessary"""
+        if not self._token:
+            self._token = self._fetch_token()
+        return self._token
+
+    def _fetch_token(self) -> str:
+        """Fetch new OAuth token"""
+        data = {
+            'grant_type': 'client_credentials',
+            'client_id': self.client_id,
+            'client_secret': self.client_secret,
+            'scope': self.scope
+        }
+
+        response = requests.post(self.auth_url, data=data)
+        response.raise_for_status()
+        
+        token_data = response.json()
+        return token_data['access_token']
+
+    def get_headers(self) -> Dict[str, str]:
+        """Get headers needed for API requests"""
+        headers = {
+            'Authorization': f'Bearer {self.get_token()}',
+            'Content-Type': 'application/json'
+        }
+        
+        if self.organization_id:
+            headers['X-UIPATH-OrganizationUnitId'] = self.organization_id
+            
+        return headers