Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Install autopep8
run: pip install --user autopep8
- name: Run autopep8
run: autopep8 -d -r parsley/ --exit-code
run: autopep8 -d -r src/parsley/ --exit-code

run_flake8:
name: Run flake8
Expand All @@ -32,4 +32,4 @@ jobs:
- name: Install basedpyright
run: pip install --user basedpyright
- name: Run basedpyright
run: basedpyright parsley
run: basedpyright src/parsley
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.11
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,14 @@ print(format_line(result))
```

## Using Parsley
You can include parsley as a submodule in your project with ```git submodule add https://github.com/waterloo-rocketry/parsley.git``` and to pull the submodule as a developer, you can use ```git submodule update --init --recursive```

The easiest way to include parsley is through `uv` if your project uses it. Run `uv add git+https://github.com/waterloo-rocketry/parsley` to add to your project.

You can also include parsley as a submodule in your project with ```git submodule add https://github.com/waterloo-rocketry/parsley.git``` and to pull the submodule as a developer, you can use ```git submodule update --init --recursive```

## Requirements
```Python 3.10``` or newer is required and the required packages can be installed using `pip install -r requirements.txt`
**You must have the `uv` Python package manager and builder installed. Visit https://docs.astral.sh/uv/getting-started/installation/ to get started. If you don't know otherwise, choose the "Standalone Installer".**

1. Run `uv sync`
2. Source virtual environment in `.venv`
3. To build, run `uv build`
44 changes: 42 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,44 @@
# pyproject.toml
[build-system]
requires = ["setuptools >= 64"]
build-backend = "setuptools.build_meta"
requires = ["uv_build>=0.8.22,<0.9.0"]
build-backend = "uv_build"

[tool.uv.build-backend]
module-name = "parsley"

[project]
name = "parsley"
version = "2025.4"
description = "Library to transcode CAN messages and human-readable text"
readme = "README.md"
license = "MIT"
authors = [
{ name = "Waterloo Rocketry", email = "contact@waterloorocketry.com" }
]
requires-python = ">=3.11"
dependencies = [
"crc8>=0.2.1",
]
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"Operating System :: OS Independent",
"Operating System :: POSIX :: Linux",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows :: Windows 10",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.11",
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries :: Python Modules",
]

[dependency-groups]
dev = [
"flake8",
"pycodestyle",
"pytest",
]

[project.urls]
Homepage = "https://github.com/waterloo-rocketry/parsley"
Repository = "https://github.com/waterloo-rocketry/parsley"

2 changes: 1 addition & 1 deletion pytest.ini
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
; need to tell pytest where to look for modules when importing code in tests/
[pytest]
pythonpath = ./parsley ./tests
pythonpath = src tests
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ max_line_length = 100
[flake8]
exclude =
__pycache__,
venv
venv,
.venv
select = E9,F63,F7,F82
max-line-length = 100
count = True
Expand Down
41 changes: 0 additions & 41 deletions setup.py

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
139 changes: 139 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.