-
Notifications
You must be signed in to change notification settings - Fork 0
Version 0.9.6 #104
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.
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
Version 0.9.6 #104
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request upgrades envstack to version 0.9.6, adding comprehensive documentation, example files, and project metadata. The changes also include a migration from setup.py to pyproject.toml, test fixture reorganization, and minor code improvements to enhance the project's accessibility and maintainability.
Changes:
- Added extensive documentation covering design philosophy, usage examples, API reference, FAQ, and tool comparisons
- Migrated build configuration from setup.py to modern pyproject.toml
- Reorganized test fixtures into a dedicated tests/fixtures/env directory
- Added project metadata files (CHANGELOG.md, CITATION.cff, TRADEMARKS.md)
- Updated version to 0.9.6 and exported additional functions from the main module
Reviewed changes
Copilot reviewed 28 out of 36 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_node.py | Updated envpath to use new fixtures directory location |
| tests/test_env.py | Centralized envpath definition and updated to use fixtures directory |
| tests/test_cmds.py | Added centralized envpath, converted string literals to raw strings |
| tests/fixtures/env/*.env | New test fixture files moved to dedicated fixtures directory |
| setup.py | Removed legacy setup.py in favor of pyproject.toml |
| pyproject.toml | New modern build configuration with project metadata and dependencies |
| lib/envstack/init.py | Bumped version to 0.9.6, exported load_environ and resolve_environ |
| lib/envstack/env.py | Fixed STACK assignment indentation, simplified docstring |
| examples/*/*.env | Added example environment files for different use cases |
| examples/*/README.md | Added documentation for example usage patterns |
| docs/*.md | Comprehensive documentation for design, examples, comparisons, FAQ, and API |
| README.md | Streamlined to focus on quickstart with links to detailed docs |
| CHANGELOG.md | Added changelog following Keep a Changelog format |
| CITATION.cff | Added citation metadata for academic/professional referencing |
| TRADEMARKS.md | Clarified trademark usage for envstack and ENVPATH |
| .gitignore | Removed keys.env to allow example key files in repository |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request adds comprehensive documentation and metadata files to the project, focusing on explaining envstack's design, usage, philosophy, and comparison to related tools. It also introduces files for changelog tracking, citation, and trademark clarification. These changes make the project more accessible and easier to understand for both users and contributors.
Documentation and usage guides:
docs/design.md, outlining envstack's goals, mental model, precedence rules, hierarchy, and composability with other systems.docs/examples.mdto demonstrate typical envstack workflows and best practices.docs/comparison.mdto clarify how envstack relates to tools like dotenv, conda, rez, uv, and distman.docs/faq.mdaddressing common questions, design tradeoffs, and sharp edges of envstack.docs/api.md.Project metadata and policy:
CHANGELOG.mdfollowing Keep a Changelog and Semantic Versioning standards to track notable changes.CITATION.cfffile to provide citation information for academic and professional referencing.TRADEMARKS.mdfile clarifying the use of "envstack" andENVPATHas project trademarks and identifiers.