nitrozenio 1.0.0__tar.gz

nitrozenio-1.0.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: nitrozenio
+Version: 1.0.0
+Summary: Official Python SDK for the Nitrozen.io changelog API
+Home-page: https://nitrozen.io
+Author: Nitrozen.io
+Author-email: "Nitrozen.io" <support@nitrozen.io>
+Project-URL: Homepage, https://nitrozen.io
+Project-URL: Repository, https://github.com/nitrozenio/nitrozen-python
+Project-URL: Documentation, https://nitrozen.io/docs
+Keywords: nitrozen,changelog,api,sdk
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: home-page
+
+# Nitrozen Python SDK
+
+Official Python client for the [Nitrozen.io](https://nitrozen.io) changelog API.
+
+[![PyPI](https://img.shields.io/pypi/v/nitrozenio)](https://pypi.org/project/nitrozenio/)
+[![Python](https://img.shields.io/pypi/pyversions/nitrozenio)](https://pypi.org/project/nitrozenio/)
+[![GitHub](https://img.shields.io/badge/github-nitrozenio%2Fnitrozen--python-blue)](https://github.com/nitrozenio/nitrozen-python)
+
+## Requirements
+
+Python 3.9+
+
+## Installation
+
+```sh
+pip install nitrozenio
+```
+
+## Quick Start
+
+```python
+import nitrozenio
+from nitrozenio.api.projects_api import ProjectsApi
+from nitrozenio.api.entries_api import EntriesApi
+
+# Configure with your API token
+configuration = nitrozenio.Configuration(
+    host="https://nitrozen.io/api/v1",
+    access_token="YOUR_API_TOKEN",
+)
+
+with nitrozenio.ApiClient(configuration) as client:
+    # List your projects
+    projects_api = ProjectsApi(client)
+    response = projects_api.projects_get()
+    for project in response.data:
+        print(f"{project.id}  {project.name}  ({project.slug})")
+
+    # Create a changelog entry
+    entries_api = EntriesApi(client)
+    entry = entries_api.projects_project_entries_post(
+        project=response.data[0].id,
+        entry_input=nitrozenio.EntryInput(
+            title="New feature",
+            content="We shipped something great.",
+            category="new",
+        ),
+    )
+    print(entry.data.title)
+```
+
+## Authentication
+
+Create an API token on the [API Tokens](https://nitrozen.io/api-tokens) page, then pass it via `access_token` in the configuration:
+
+```python
+configuration = nitrozenio.Configuration(
+    host="https://nitrozen.io/api/v1",
+    access_token="YOUR_API_TOKEN",
+)
+```
+
+## Error Handling
+
+API errors raise `ApiException`, which carries the HTTP status code and response body:
+
+```python
+from nitrozenio.exceptions import ApiException
+
+try:
+    response = projects_api.projects_project_get(project=999)
+except ApiException as e:
+    print(e.status)   # e.g. 404
+    print(e.reason)   # e.g. "Not Found"
+    print(e.body)     # raw JSON error body
+```
+
+## Pagination
+
+List endpoints accept `page` and `per_page` parameters and return a `meta` object:
+
+```python
+response = entries_api.projects_project_entries_get(
+    project=project_id,
+    page=2,
+    per_page=20,
+)
+print(f"page {response.meta.current_page} of {response.meta.last_page} ({response.meta.total} total)")
+for entry in response.data:
+    print(f"{entry.id}  {entry.title}")
+```
+
+## API Reference
+
+All URIs are relative to `https://nitrozen.io/api/v1`.
+
+### Authentication
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `AuthenticationApi.tokens_get()` | GET /tokens | List API tokens |
+| `AuthenticationApi.tokens_post(body)` | POST /tokens | Create an API token |
+| `AuthenticationApi.tokens_token_delete(id)` | DELETE /tokens/{token} | Revoke an API token |
+
+### Projects
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `ProjectsApi.projects_get()` | GET /projects | List projects |
+| `ProjectsApi.projects_post(body)` | POST /projects | Create a project |
+| `ProjectsApi.projects_project_get(id)` | GET /projects/{project} | Get a project |
+| `ProjectsApi.projects_project_put(id, body)` | PUT /projects/{project} | Update a project |
+| `ProjectsApi.projects_project_delete(id)` | DELETE /projects/{project} | Delete a project |
+
+### Entries
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `EntriesApi.projects_project_entries_get(id, page?, per_page?)` | GET /projects/{project}/entries | List entries |
+| `EntriesApi.projects_project_entries_post(id, body)` | POST /projects/{project}/entries | Create an entry |
+| `EntriesApi.projects_project_entries_entry_get(pid, eid)` | GET …/entries/{entry} | Get an entry |
+| `EntriesApi.projects_project_entries_entry_put(pid, eid, body)` | PUT …/entries/{entry} | Update an entry |
+| `EntriesApi.projects_project_entries_entry_delete(pid, eid)` | DELETE …/entries/{entry} | Delete an entry |
+
+### Users
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `UsersApi.user_get()` | GET /user | Get current user |
+| `UsersApi.user_usage_get()` | GET /user/usage | Get usage statistics |
+
+### Public
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `PublicApi.public_projects_slug_entries_get(slug)` | GET /public/projects/{slug}/entries | List published entries (no auth) |
+
+Valid values for the `category` field: `new`, `improvement`, `fix`, `announcement`
+
+## Links
+
+- [Documentation](https://nitrozen.io/docs)
+- [API Reference](https://nitrozen.io/docs/api)
+- [GitHub](https://github.com/nitrozenio/nitrozen-python)
+- [PyPI](https://pypi.org/project/nitrozenio/)

nitrozenio-1.0.0/README.md

@@ -0,0 +1,145 @@
+# Nitrozen Python SDK
+
+Official Python client for the [Nitrozen.io](https://nitrozen.io) changelog API.
+
+[![PyPI](https://img.shields.io/pypi/v/nitrozenio)](https://pypi.org/project/nitrozenio/)
+[![Python](https://img.shields.io/pypi/pyversions/nitrozenio)](https://pypi.org/project/nitrozenio/)
+[![GitHub](https://img.shields.io/badge/github-nitrozenio%2Fnitrozen--python-blue)](https://github.com/nitrozenio/nitrozen-python)
+
+## Requirements
+
+Python 3.9+
+
+## Installation
+
+```sh
+pip install nitrozenio
+```
+
+## Quick Start
+
+```python
+import nitrozenio
+from nitrozenio.api.projects_api import ProjectsApi
+from nitrozenio.api.entries_api import EntriesApi
+
+# Configure with your API token
+configuration = nitrozenio.Configuration(
+    host="https://nitrozen.io/api/v1",
+    access_token="YOUR_API_TOKEN",
+)
+
+with nitrozenio.ApiClient(configuration) as client:
+    # List your projects
+    projects_api = ProjectsApi(client)
+    response = projects_api.projects_get()
+    for project in response.data:
+        print(f"{project.id}  {project.name}  ({project.slug})")
+
+    # Create a changelog entry
+    entries_api = EntriesApi(client)
+    entry = entries_api.projects_project_entries_post(
+        project=response.data[0].id,
+        entry_input=nitrozenio.EntryInput(
+            title="New feature",
+            content="We shipped something great.",
+            category="new",
+        ),
+    )
+    print(entry.data.title)
+```
+
+## Authentication
+
+Create an API token on the [API Tokens](https://nitrozen.io/api-tokens) page, then pass it via `access_token` in the configuration:
+
+```python
+configuration = nitrozenio.Configuration(
+    host="https://nitrozen.io/api/v1",
+    access_token="YOUR_API_TOKEN",
+)
+```
+
+## Error Handling
+
+API errors raise `ApiException`, which carries the HTTP status code and response body:
+
+```python
+from nitrozenio.exceptions import ApiException
+
+try:
+    response = projects_api.projects_project_get(project=999)
+except ApiException as e:
+    print(e.status)   # e.g. 404
+    print(e.reason)   # e.g. "Not Found"
+    print(e.body)     # raw JSON error body
+```
+
+## Pagination
+
+List endpoints accept `page` and `per_page` parameters and return a `meta` object:
+
+```python
+response = entries_api.projects_project_entries_get(
+    project=project_id,
+    page=2,
+    per_page=20,
+)
+print(f"page {response.meta.current_page} of {response.meta.last_page} ({response.meta.total} total)")
+for entry in response.data:
+    print(f"{entry.id}  {entry.title}")
+```
+
+## API Reference
+
+All URIs are relative to `https://nitrozen.io/api/v1`.
+
+### Authentication
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `AuthenticationApi.tokens_get()` | GET /tokens | List API tokens |
+| `AuthenticationApi.tokens_post(body)` | POST /tokens | Create an API token |
+| `AuthenticationApi.tokens_token_delete(id)` | DELETE /tokens/{token} | Revoke an API token |
+
+### Projects
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `ProjectsApi.projects_get()` | GET /projects | List projects |
+| `ProjectsApi.projects_post(body)` | POST /projects | Create a project |
+| `ProjectsApi.projects_project_get(id)` | GET /projects/{project} | Get a project |
+| `ProjectsApi.projects_project_put(id, body)` | PUT /projects/{project} | Update a project |
+| `ProjectsApi.projects_project_delete(id)` | DELETE /projects/{project} | Delete a project |
+
+### Entries
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `EntriesApi.projects_project_entries_get(id, page?, per_page?)` | GET /projects/{project}/entries | List entries |
+| `EntriesApi.projects_project_entries_post(id, body)` | POST /projects/{project}/entries | Create an entry |
+| `EntriesApi.projects_project_entries_entry_get(pid, eid)` | GET …/entries/{entry} | Get an entry |
+| `EntriesApi.projects_project_entries_entry_put(pid, eid, body)` | PUT …/entries/{entry} | Update an entry |
+| `EntriesApi.projects_project_entries_entry_delete(pid, eid)` | DELETE …/entries/{entry} | Delete an entry |
+
+### Users
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `UsersApi.user_get()` | GET /user | Get current user |
+| `UsersApi.user_usage_get()` | GET /user/usage | Get usage statistics |
+
+### Public
+
+| Method | HTTP | Description |
+|--------|------|-------------|
+| `PublicApi.public_projects_slug_entries_get(slug)` | GET /public/projects/{slug}/entries | List published entries (no auth) |
+
+Valid values for the `category` field: `new`, `improvement`, `fix`, `announcement`
+
+## Links
+
+- [Documentation](https://nitrozen.io/docs)
+- [API Reference](https://nitrozen.io/docs/api)
+- [GitHub](https://github.com/nitrozenio/nitrozen-python)
+- [PyPI](https://pypi.org/project/nitrozenio/)

nitrozenio-1.0.0/nitrozenio/__init__.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Nitrozen API
+
+    The Nitrozen API allows you to programmatically manage your changelog projects and entries.  ## Authentication  All authenticated endpoints require a Bearer token. Create an API token from your [API Tokens](/api-tokens) page, then include it in the `Authorization` header:  ``` Authorization: Bearer YOUR_TOKEN_HERE ```  ## Rate Limiting  API rate limits are determined by your plan. Each plan specifies a `api_rate_limit` value (requests per minute). When the limit is exceeded, the API returns a `429 Too Many Requests` response. Unauthenticated requests are limited to 60 requests per minute per IP address.  ## Pagination  List endpoints that support pagination accept `page` and `per_page` query parameters. The response includes a `meta` object with pagination details. 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AuthenticationApi",
+    "EntriesApi",
+    "ProjectsApi",
+    "PublicApi",
+    "UsersApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "Entry",
+    "EntryInput",
+    "Error",
+    "NewToken",
+    "PaginationMeta",
+    "Project",
+    "ProjectInput",
+    "ProjectsGet200Response",
+    "ProjectsPost201Response",
+    "ProjectsProjectEntriesGet200Response",
+    "ProjectsProjectEntriesPost201Response",
+    "PublicProjectsSlugEntriesGet200Response",
+    "TokenInfo",
+    "TokensGet200Response",
+    "TokensPost201Response",
+    "TokensPostRequest",
+    "Usage",
+    "UsageLimits",
+    "User",
+    "UserGet200Response",
+    "UserPlan",
+    "UserUsageGet200Response",
+    "ValidationError",
+]
+
+# import apis into sdk package
+from nitrozenio.api.authentication_api import AuthenticationApi as AuthenticationApi
+from nitrozenio.api.entries_api import EntriesApi as EntriesApi
+from nitrozenio.api.projects_api import ProjectsApi as ProjectsApi
+from nitrozenio.api.public_api import PublicApi as PublicApi
+from nitrozenio.api.users_api import UsersApi as UsersApi
+
+# import ApiClient
+from nitrozenio.api_response import ApiResponse as ApiResponse
+from nitrozenio.api_client import ApiClient as ApiClient
+from nitrozenio.configuration import Configuration as Configuration
+from nitrozenio.exceptions import OpenApiException as OpenApiException
+from nitrozenio.exceptions import ApiTypeError as ApiTypeError
+from nitrozenio.exceptions import ApiValueError as ApiValueError
+from nitrozenio.exceptions import ApiKeyError as ApiKeyError
+from nitrozenio.exceptions import ApiAttributeError as ApiAttributeError
+from nitrozenio.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from nitrozenio.models.entry import Entry as Entry
+from nitrozenio.models.entry_input import EntryInput as EntryInput
+from nitrozenio.models.error import Error as Error
+from nitrozenio.models.new_token import NewToken as NewToken
+from nitrozenio.models.pagination_meta import PaginationMeta as PaginationMeta
+from nitrozenio.models.project import Project as Project
+from nitrozenio.models.project_input import ProjectInput as ProjectInput
+from nitrozenio.models.projects_get200_response import ProjectsGet200Response as ProjectsGet200Response
+from nitrozenio.models.projects_post201_response import ProjectsPost201Response as ProjectsPost201Response
+from nitrozenio.models.projects_project_entries_get200_response import ProjectsProjectEntriesGet200Response as ProjectsProjectEntriesGet200Response
+from nitrozenio.models.projects_project_entries_post201_response import ProjectsProjectEntriesPost201Response as ProjectsProjectEntriesPost201Response
+from nitrozenio.models.public_projects_slug_entries_get200_response import PublicProjectsSlugEntriesGet200Response as PublicProjectsSlugEntriesGet200Response
+from nitrozenio.models.token_info import TokenInfo as TokenInfo
+from nitrozenio.models.tokens_get200_response import TokensGet200Response as TokensGet200Response
+from nitrozenio.models.tokens_post201_response import TokensPost201Response as TokensPost201Response
+from nitrozenio.models.tokens_post_request import TokensPostRequest as TokensPostRequest
+from nitrozenio.models.usage import Usage as Usage
+from nitrozenio.models.usage_limits import UsageLimits as UsageLimits
+from nitrozenio.models.user import User as User
+from nitrozenio.models.user_get200_response import UserGet200Response as UserGet200Response
+from nitrozenio.models.user_plan import UserPlan as UserPlan
+from nitrozenio.models.user_usage_get200_response import UserUsageGet200Response as UserUsageGet200Response
+from nitrozenio.models.validation_error import ValidationError as ValidationError
+

nitrozenio-1.0.0/nitrozenio/api/__init__.py

@@ -0,0 +1,9 @@
+# flake8: noqa
+
+# import apis into api package
+from nitrozenio.api.authentication_api import AuthenticationApi
+from nitrozenio.api.entries_api import EntriesApi
+from nitrozenio.api.projects_api import ProjectsApi
+from nitrozenio.api.public_api import PublicApi
+from nitrozenio.api.users_api import UsersApi
+