netbird 0.1.0__tar.gz

netbird-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'README.md'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'README.md'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+          working-directory: ./docs
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with Jekyll
+        run: |
+          cd docs
+          bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_site
+
+  # Deployment job
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

netbird-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,99 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      publish_to_test:
+        description: 'Publish to Test PyPI instead of PyPI'
+        required: false
+        default: false
+        type: boolean
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package
+      run: python -m twine check dist/*
+    
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e ".[dev]"
+    
+    - name: Run tests
+      run: |
+        pytest --cov=src/netbird --cov-report=term-missing
+    
+    - name: Run type checking
+      run: mypy src/
+    
+    - name: Run linting
+      run: |
+        black --check src/ tests/
+        isort --check-only src/ tests/
+        flake8 src/ tests/ --max-line-length=88
+
+  publish:
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    environment: 
+      name: ${{ github.event.inputs.publish_to_test == 'true' && 'test-pypi' || 'pypi' }}
+      url: ${{ github.event.inputs.publish_to_test == 'true' && 'https://test.pypi.org/p/netbird' || 'https://pypi.org/p/netbird' }}
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Publish to Test PyPI
+      if: github.event.inputs.publish_to_test == 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+    
+    - name: Publish to PyPI
+      if: github.event.inputs.publish_to_test != 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1

netbird-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

netbird-0.1.0/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+All notable changes to the NetBird Python Client will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - TBD
+
+### Added
+- Initial release of NetBird Python Client
+- Complete API coverage for all 11 NetBird API resources:
+  - Accounts - Account management and settings
+  - Users - User lifecycle management with roles and permissions
+  - Tokens - API token management for users
+  - Peers - Network peer management and connectivity
+  - Setup Keys - Peer setup key management with auto-groups
+  - Groups - Peer group management and organization
+  - Networks - Network and resource management with nested resources
+  - Policies - Access control policies with rules and posture checks
+  - Routes - Network routing configuration with masquerading
+  - DNS - DNS settings and nameserver group management
+  - Events - Audit events and network traffic monitoring
+- Modern Python package structure with pyproject.toml
+- Type-safe Pydantic models for all API objects
+- Comprehensive error handling with specific exception types:
+  - `NetBirdAPIError` - Base exception for all API errors
+  - `NetBirdAuthenticationError` - Authentication failures (401)
+  - `NetBirdValidationError` - Request validation errors (400)
+  - `NetBirdNotFoundError` - Resource not found errors (404)
+  - `NetBirdRateLimitError` - Rate limiting errors (429)
+  - `NetBirdServerError` - Server errors (5xx)
+- Flexible authentication support:
+  - Personal access tokens
+  - Service user tokens
+  - Bearer token authentication
+- HTTP client with proper timeout and error handling
+- Context manager support for resource cleanup
+- Extensive documentation and examples:
+  - Complete README with usage examples
+  - API reference documentation
+  - Practical example scripts
+  - Type hints and docstrings throughout
+- Development tooling:
+  - pytest for testing with coverage reporting
+  - mypy for type checking
+  - black for code formatting
+  - isort for import sorting
+  - flake8 for linting
+  - pre-commit hooks for code quality
+
+### Features
+- **Complete Resource Coverage**: Support for all NetBird API endpoints
+- **Type Safety**: Full typing support with runtime validation
+- **Error Handling**: Comprehensive exception hierarchy for different error types
+- **Authentication**: Multiple authentication methods supported
+- **Documentation**: Extensive docs with practical examples
+- **Modern Python**: Built for Python 3.8+ with modern packaging
+- **Developer Experience**: Rich tooling and clear error messages
+
+### Examples Included
+- `basic_client.py` - Basic API usage and resource listing
+- `user_management.py` - User creation, tokens, and role management
+- `network_automation.py` - Complete network setup automation
+
+### Development
+- Modern pyproject.toml configuration
+- Comprehensive test suite setup
+- Type checking with mypy
+- Code formatting with black and isort
+- Linting with flake8
+- Coverage reporting with pytest-cov
+
+---
+
+## Release Notes
+
+### Version 0.1.0
+This is the initial release of the NetBird Python Client. It provides complete coverage of the NetBird API with a focus on developer experience, type safety, and comprehensive documentation.
+
+**Key Highlights:**
+- 🎯 **Complete API Coverage** - All 11 NetBird resources supported
+- 🔒 **Type Safe** - Full Pydantic model validation
+- 📚 **Well Documented** - Extensive docs and examples
+- 🚀 **Production Ready** - Proper error handling and testing
+- 🐍 **Modern Python** - Built for Python 3.8+ with best practices
+
+The client is designed to be intuitive for NetBird users while providing the flexibility needed for automation and integration scenarios.