Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug report
description: Report something that isn't working as expected
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for filing a bug. The fields below are what we'd otherwise have to
ask for — filling them in gets your issue triaged and fixed faster.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear description of the bug — what you observed.
placeholder: When I called …, the client …
validations:
required: true
- type: textarea
id: repro
attributes:
label: Steps to reproduce
description: A minimal code snippet so we can see it too.
placeholder: |
from isms import IsmsClient
client = IsmsClient.from_env()
client.suppliers.list() # → ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected vs. actual
description: What you expected to happen, and what actually happened instead.
validations:
required: true
- type: dropdown
id: component
attributes:
label: Component / surface
description: Which part of the client is affected?
options:
- "Client / resources (suppliers, risks, incidents, …)"
- Authentication / tokens
- from_env / env-file loader
- Exceptions / error handling
- Packaging / install / types
- Other
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: isms-python version (`pip show isms`) and the ISMS server version if known.
placeholder: isms-python 0.1.0 / server 0.7.x
validations:
required: true
- type: input
id: python
attributes:
label: Python version
placeholder: "3.12"
validations:
required: true
- type: textarea
id: context
attributes:
label: Anything else?
description: Tracebacks, request/response details, and deployment specifics all help.
validations:
required: false
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Maintainers still file rich free-form issues — keep the blank option.
blank_issues_enabled: true
contact_links:
- name: Report a security vulnerability
url: mailto:security@isms.sh
about: Do NOT open a public issue for security problems. Email security@isms.sh directly — see SECURITY.md for what to include and our coordinated-disclosure policy.
- name: Question or support
url: https://github.com/unidoc/isms-python/discussions
about: Ask questions and get help in GitHub Discussions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation
description: Report a gap or inaccuracy in the documentation
title: "[Docs]: "
labels: ["documentation"]
body:
- type: input
id: location
attributes:
label: Where?
description: Which doc, page, or file — a link or path.
placeholder: README.md / docs/releasing.md / docs page URL
validations:
required: true
- type: textarea
id: gap
attributes:
label: What's missing or wrong?
description: The gap, inaccuracy, or point of confusion.
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested fix
description: Optional — how you'd improve it.
validations:
required: false
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature request
description: Suggest an improvement or a new capability
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: Problem / motivation
description: What are you trying to do, and what's getting in the way? Lead with the why, not the solution.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description: What you'd like to see happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other approaches you thought about, and why they fall short.
validations:
required: false
50 changes: 50 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# CI — lint + unit tests for the Python client.
#
# Security model (public repo, fork PRs welcome):
# - `pull_request` trigger only — NEVER `pull_request_target`. Fork PRs run in
# an isolated ephemeral VM with a read-only GITHUB_TOKEN and no secrets.
# - This workflow uses no secrets; there is nothing to exfiltrate.
# - `permissions: contents: read` pins the token to read-only even on push.

name: tests

on:
push:
branches: [master]
pull_request:

permissions:
contents: read

concurrency:
group: tests-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lint:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- run: pip install --quiet -e ".[dev]"
- name: ruff
run: ruff check src tests

test:
runs-on: ubuntu-latest
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- run: pip install --quiet -e ".[dev]"
- name: pytest
run: pytest -q
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
__pycache__/
*.py[cod]
*.egg-info/
build/
dist/
.eggs/
.venv/
venv/
.env
.envrc
.pytest_cache/
.coverage
.coverage.*
htmlcov/
.tox/
.mypy_cache/
.ruff_cache/
*.log

# Local scratch / torun scripts — never committed.
temp/
87 changes: 87 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

Community spaces for this project include the GitHub repository, issue tracker, pull requests, code reviews, and any other project communication channels such as mailing lists, chat platforms, or forums affiliated with the project.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **conduct@isms.sh**. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

If the reported party is a project maintainer or owner, reporters may escalate directly to **hr@isms.sh** instead of using the standard enforcement contact, to ensure an impartial review free from conflict of interest.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to isms-python

Thank you for your interest in contributing.

## Process

1. **Open an issue first** to discuss the change you'd like to make.
2. Fork the repository and create a feature branch.
3. Make your changes and ensure tests pass.
4. Submit a pull request referencing the issue.

## Development Setup

- Python 3.10+

```bash
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
```

## Running Tests

```bash
ruff check src tests
pytest
```

Both run in CI on every pull request across Python 3.10–3.13.

## Code Style

- **Ruff** for linting and formatting (`ruff check src tests`). Line length 100.
- Full type hints; the package ships a `py.typed` marker.
- Keep commits focused. One logical change per commit.
- The client mirrors the ISMS REST API — new resources/endpoints must match the
server's actual routes.

## License

By contributing, you agree that your contributions will be licensed under the
[Apache License 2.0](LICENSE).
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ Point the client at your ISMS deployment and give it an API token:
```sh
export ISMS_API_URL=https://your-org.isms.sh
export ISMS_API_TOKEN=<api-token>
export ISMS_ORGANIZATION=<org-slug> # only if your token spans multiple orgs
# Only needed for a multi-org token on a bare domain; a subdomain URL
# (https://your-org.isms.sh) already selects the org server-side.
export ISMS_ORGANIZATION_UUID=<org-uuid>
```

Create the token from an admin session with `isms server api-key create`
Expand Down
25 changes: 25 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Security Policy

## Reporting a Vulnerability

**Do not open a public issue for security vulnerabilities.**

Please report security issues by emailing **security@isms.sh**. Include:

- Description of the vulnerability
- Steps to reproduce
- Potential impact

## Response Timeline

- **Acknowledgement** within 2 business days.
- **Initial assessment** within 5 business days.
- **Fix or mitigation** timeline communicated after assessment.

## Supported Versions

Security fixes are applied to the latest release only. We recommend always running the most recent version.

## Disclosure

We follow coordinated disclosure. We will credit reporters (unless anonymity is requested) once a fix is released.
Loading
Loading