chore: initial library setup #1
Merged
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
- Initialise this project as a python 3.13+ library via the uv manager: https://docs.astral.sh/uv/concepts/projects/init/#libraries - Blank py.typed file denotes our library distributes type information. - Add project + developer dependencies. - Configure ruff formater to also check docstrings: https://docs.astral.sh/ruff/
Run checks automatically before each commit: - `pre-commit-hooks` performs general file checks (e.g. remove trailing whitespace) - `uv-pre-commit` ensures dependency lock file is up-to-date. - `ruff-pre-commit` performs linting and formatting checks. See: https://pre-commit.com/
Show how to setup project via uv or pip.
Perform linting + formatting checks.
|
Thanks @lysj-cpu 👍 |
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.
Please review this commit-by-commit. Thank you!
This initial PR sets up a basic uv py3.13+ library with brax/mujoco/mujoco-mjx dependencies.
Automated linting/formatting checks are provided by ruff and pre-commit. This is enforced via GitHub CI, and rules can be configured via the
pyproject.toml. In our Notion, we suggest the use of black and flake8, but ruff has drop-in parity with both these tools.Please review the development documentation in the README for more information. Thanks 👍