feat: prepare PyMapGIS for PyPI publication#10
Merged
nicholaskarlson merged 6 commits intomainfrom Jun 7, 2025
Merged
Conversation
- Add comprehensive caching system with TTL support - Add housing cost burden and labor force gap examples - Update dependencies and configuration - Add GitHub Actions workflow for examples - Fix linting issues in example code
- Update README with comprehensive project description - Add CONTRIBUTING.md with development guidelines - Add CHANGELOG.md for version tracking - Update pyproject.toml with PyPI metadata and classifiers - Complete MIT license text - Add GitHub issue and PR templates - Update .gitignore with comprehensive Python exclusions - Remove cache files and temporary test files
Comment on lines
+10
to
+17
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: "3.11" | ||
| - run: pip install -r labor_force_gap/after/requirements.txt | ||
| - run: python labor_force_gap/after/app.py --headless || true |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 10 months ago
To fix the issue, we need to add a permissions block to the workflow. Since the workflow performs basic CI tasks, the minimal required permission is contents: read. This ensures that the GITHUB_TOKEN has only read access to the repository contents, adhering to the principle of least privilege.
The permissions block should be added at the root level of the workflow, so it applies to all jobs. Alternatively, it can be added to the specific job (run-demo) if different jobs require different permissions.
Suggested changeset
1
.github/workflows/examples.yml
| @@ -1,2 +1,4 @@ | ||
| name: Examples smoke-test | ||
| permissions: | ||
| contents: read | ||
| on: |
Copilot is powered by AI and may make mistakes. Always verify output.
- Add publish.yml workflow for automated PyPI publishing - Enhance CI workflow with multi-Python version testing - Add linting job to CI pipeline - Support both PyPI and TestPyPI publishing - Include Sigstore signing for security
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.
This PR prepares PyMapGIS for publication on PyPI with comprehensive documentation, proper project structure, and community guidelines.
Changes Made
Repository Structure
Documentation
PyPI Preparation
GitHub Repository Polish
Ready for PyPI
This PR makes PyMapGIS ready for publication on PyPI.org, enabling other developers to:
Testing