Skip to content

DOCS: Initial package setup and PyPI publication (v0.0.1) #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LeonardNoh merged 3 commits into from
Oct 22, 2025
Merged

DOCS: Initial package setup and PyPI publication (v0.0.1) #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55a8e38
DOCS: Update governance model to voidbox-led development
LeonardNoh Oct 22, 2025
a8035da
DOCS: Simplify documentation structure
LeonardNoh Oct 22, 2025
b8acf8a
Merge branch 'voidbox-ai:main' into main
LeonardNoh Oct 22, 2025
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
211 changes: 0 additions & 211 deletions CONTRIBUTING.md
View file
Open in desktop

This file was deleted.

45 changes: 4 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,56 +26,19 @@ from pyaps import auth
# Coming soon - SDK implementation in progress
```

## Development

### Setting Up Development Environment

1. Clone the repository:
```bash
git clone https://github.com/voidbox-ai/pyaps.git
cd pyaps
```

2. Install in development mode with test dependencies:
```bash
pip install -e ".[dev]"
```

### Running Tests

Run all tests:
```bash
pytest
```

Run with coverage report:
```bash
pytest --cov=pyaps --cov-report=term-missing
```

### Continuous Integration

All pull requests are automatically tested via GitHub Actions on:
- Python versions: 3.9, 3.10, 3.11, 3.12
- Operating systems: Ubuntu, Windows, macOS

Tests must pass before merging.

## Project Status

This package is currently in early development (v0.0.1). The package name has been reserved on PyPI, and active development is underway.
This package is currently in early development (v0.0.1). The package name has been reserved on PyPI, and active development is underway by **voidbox**.

## Contributing

Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a Pull Request.
We welcome bug reports and feature requests through [GitHub Issues](https://github.com/voidbox-ai/pyaps/issues).

### Quick Links for Contributors
- [Contributing Guidelines](CONTRIBUTING.md) - Full contribution guide
- [Commit Convention](.github/COMMIT_CONVENTION.md) - Quick reference for commit messages
This project is primarily developed by voidbox. External pull requests have limited review capacity.

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
Apache-2.0 License - see the [LICENSE](LICENSE) file for details.

## Links

Expand Down