chore: configure Poetry environment, secure credentials with .env, and update documentation - #3
Open
cherry-git999 wants to merge 2 commits into
Open
chore: configure Poetry environment, secure credentials with .env, and update documentation#3cherry-git999 wants to merge 2 commits into
cherry-git999 wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the project's dependency and development environment management to use Poetry correctly, introduces secure credential management via environment variables (
.env), and updates the setup and execution documentation.Changes Made
1. Poetry & Dependency Management
>=3.10,<4.0inpyproject.toml.[tool.poetry.group.dev.dependencies]) includingpytest,ruff,mypy,pandas-stubs, andtypes-requests.python-dotenvfor loading environment credentials.poetry.lock.2. Environment & Security Configuration
.env.exampleas a template for ERPNext authentication credentials..gitignoreto ensure.envand local secret files are strictly ignored while tracking.env.example..ruff_cache/,.mypy_cache/,.pytest_cache/) to.gitignore.example.pyto readERPNEXT_USERNAMEandERPNEXT_PASSWORDsecurely viadotenvinstead of hardcoding values.3. Documentation
README.mdwith step-by-step instructions for installation (poetry install), credential configuration (cp .env.example .env), and running scripts (poetry run python example.py).Verification
poetry install).poetry run python example.py.poetry run mypy erp_client) and linting (poetry run ruff check erp_client).