This repository has been archived by the owner on Jun 14, 2024. It is now read-only.
feat: Setup packaging and Github Codespaces dev environment #26
Conversation
This file contains 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
Add SSEC badge
Update Codespaces link
Update Codespaces link
- Add jupyter-book
Update Codespaces button to new repo name
lsetiawan
added a commit
that referenced
this pull request
Dec 1, 2023
…rary Development Guide (Ciela-Institute#103) * feat: Setup packaging and Github Codespaces dev environment (#26) * Update README.md Add SSEC badge * Move project to src/ directory * Update Codespaces link * Update README.md * Update README.md Update Codespaces link * Update devcontainer * ci: Create cd.yml for building and pushing package * Update caustic name to caustics * Add PyLint and Black formatting features to devcon * Closes issue #16 * Updated test/ -> tests/ * Move project to src/ directory * Update README.md * Update README.md Update Codespaces link * Create noxfile.py * Add .readthedocs.yaml * Create .git_archival.txt * Create .gitattributes * Create .pre-commit-config.yaml * Add sphinx and myst-parser support * style: pre-commit fixes * Update docs * style: pre-commit fixes * Update .github Actions * Update environment.yml - Add jupyter-book * Create CONTRIBUTING.md * Update README.md * chore: resolve conflicts * chore: Remove sources * test: remove test lenses * test: fix test_simulator * chore: Set min python to 3.9 * fix: change pytest to point to tests/ * build: update dep list to use reqs.txt * ci: Don't fail fast * chore(deps): Pin astropy < 6 * fix: change instances of caustic to caustics * fix: Perform pre-commit * fix: update path to conf.py * update README * style: pre-commit fixes * docs: Add contributor graph * chore: Setup dynamic versioning * ci: Update fetch depth to 0 to get correct version * Update README.md Update Codespaces button to new repo name --------- Co-authored-by: Cordero Core <127983572+uwcdc@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * build: remove dir sources (#27) * fix: Add project urls to empty slots * ci: update yaml configuration for CI (#28) * ci: update yaml configuration for CI * style: pre-commit fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Update README.md Added issue to contribution section * Update conf.py Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com> * Update pixelated_convergence.py Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com> * Update test_parametrized.py Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com> * Update test_parametrized.py Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com> * Update cd.yml * Update cd.yml * Update cd.yml * Update README.md * docs: Grab version from package __version__ * Update README.md * Add nox dependency * Update noxfile.py * Update CONTRIBUTING.md Temporarily removing instructions for `docs` * Remove `docs` instructions (temp) * Add tutorials and update nox instructions * Update `nox` instructions in CONTRIBUTING.md (#3) * Updated local nox instructions * Remove tutorials * Update nox install instruction and noxfile --------- Co-authored-by: Cordero Core <127983572+uwcdc@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Overview
This PR restructured the package and add Github codespaces coding environment. This is a duplicate of #23 with recent changes included in rebase.
Issues Addressed
causticpackage name tocaustics#24.devcontainer/devcontainer.jsonfor default codespace configuration #16noxfile.pyfor easy setup or build of package #10.readthedocs.ymlfor hosting documentation on ReadTheDocs #9.pre-commit-config.yamlfor setting uppre-commit#8.github/dependabot.ymlfor updating github actions versions #7cd.ymlfor automated wheel building and pushing to pypa #6testtotests#4srcdirectory #2