Skip to content

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

Merged
LeonardNoh merged 3 commits into
voidbox-ai:mainfrom
LeonardNoh:main
Oct 22, 2025
Merged

DOCS: Initial package setup and PyPI publication (v0.0.1)#4
LeonardNoh merged 3 commits into
voidbox-ai:mainfrom
LeonardNoh:main

Conversation

@LeonardNoh

Copy link
Copy Markdown
Contributor

Summary

This PR establishes the foundational setup for py-aps and publishes v0.0.1 to PyPI to reserve the package name.

Changes

Package Configuration

  • pyproject.toml: Package metadata with Apache-2.0 license, dependencies, and build configuration
  • Package Structure: Initial src/pyaps/ module structure with auth, datamanagement, and automation modules

Testing Infrastructure

  • pytest Configuration: pytest.ini with coverage settings
  • Basic Tests: Import tests for all modules (100% coverage)
  • GitHub Actions CI: Automated testing on Python 3.9-3.12 across Ubuntu, Windows, macOS
  • Dev Dependencies: pytest, pytest-cov, pytest-asyncio

Documentation

  • README.md: Clean, concise documentation with installation, features, and project information
  • Commit Convention: Quick reference guide in .github/COMMIT_CONVENTION.md
  • Development is led by voidbox with limited external PR capacity

PyPI Publication

Published to PyPI: https://pypi.org/project/py-aps/0.0.1/

pip install py-aps
Testing
All tests pass locally with 100% coverage:
$ pytest
============================== 4 passed in 0.11s ===============================
Coverage: 100%
GitHub Actions will run automated tests on this PR.
Commits
This PR includes 6 commits:
Add initial package configuration and structure
Update README with comprehensive package information
DOCS: Add contribution guidelines and commit convention
TEST: Add pytest testing infrastructure and CI/CD
DOCS: Update governance model to voidbox-led development
DOCS: Simplify documentation structure
All commits follow the established commit convention (FEAT, FIX, DOCS, BUILD, CHORE, REFACTOR, TEST).
Next Steps
With this foundation, future development will focus on:
OAuth2 authentication implementation
APS Data Management API integration
Design automation workflows
🤖 Generated with [Claude Code](https://claude.com/claude-code)

LeonardNoh and others added 3 commits October 22, 2025 19:15
- Update CONTRIBUTING.md to reflect voidbox-led development model
  - Clarify limited capacity for external PRs
  - Emphasize issue reporting and small contributions
  - Add clear acceptance criteria for contributions
  - Simplify guidelines while maintaining quality standards

- Update README.md contribution section
  - Highlight voidbox as primary maintainer
  - Set expectations for external contributions
  - Encourage bug reports and feature requests

- Add GOVERNANCE.md for project governance clarity
  - Define company-led open source model
  - Outline roles and responsibilities
  - Document decision-making process
  - Establish release process and communication channels

This change establishes clear expectations for community participation
while maintaining the open source nature of the project.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Remove CONTRIBUTING.md and GOVERNANCE.md files
- Simplify README.md to essential information only
  - Remove Development section
  - Remove detailed contribution guidelines
  - Keep brief Contributing section with clear expectations
  - Maintain core project information

This streamlines the documentation and reduces maintenance overhead
while keeping essential information for users.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@LeonardNoh
LeonardNoh merged commit 0c1f31b into voidbox-ai:main Oct 22, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant