Skip to content

Conversation

@rsgalloway
Copy link
Owner

@rsgalloway rsgalloway commented Jan 12, 2026

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:

  • Added detailed design and philosophy documentation in docs/design.md, outlining envstack's goals, mental model, precedence rules, hierarchy, and composability with other systems.
  • Introduced usage examples and common patterns in docs/examples.md to demonstrate typical envstack workflows and best practices.
  • Added a comparison document in docs/comparison.md to clarify how envstack relates to tools like dotenv, conda, rez, uv, and distman.
  • Provided a FAQ in docs/faq.md addressing common questions, design tradeoffs, and sharp edges of envstack.
  • Documented the Python API and configuration environment variables in docs/api.md.

Project metadata and policy:

  • Created a CHANGELOG.md following Keep a Changelog and Semantic Versioning standards to track notable changes.
  • Added a CITATION.cff file to provide citation information for academic and professional referencing.
  • Introduced a TRADEMARKS.md file clarifying the use of "envstack" and ENVPATH as project trademarks and identifiers.

@rsgalloway rsgalloway linked an issue Jan 12, 2026 that may be closed by this pull request
@rsgalloway rsgalloway self-assigned this Jan 12, 2026
@rsgalloway rsgalloway linked an issue Jan 12, 2026 that may be closed by this pull request
@rsgalloway rsgalloway added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 12, 2026
@rsgalloway rsgalloway linked an issue Jan 12, 2026 that may be closed by this pull request
@rsgalloway rsgalloway added this to the Version 0.9.6 milestone Jan 12, 2026
@rsgalloway rsgalloway marked this pull request as ready for review January 12, 2026 00:39
@rsgalloway rsgalloway requested a review from Copilot January 12, 2026 00:40
Copy link

Copilot AI left a 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.

@rsgalloway rsgalloway merged commit 9ee5644 into master Jan 12, 2026
6 checks passed
@rsgalloway rsgalloway deleted the v0.9.6 branch January 12, 2026 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add CHANGELOG.md for release history and transparency migrate packaging to pyproject.toml SyntaxWarning

2 participants