Skip to content

Commit

Permalink
feat: disable package mode for the poetry and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
illya-laifu committed Nov 28, 2024
1 parent c73ffea commit 1c73048
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,32 @@

This submodule contains bindings to the Taskchampion

# TODO
## Development

This project is built using [maturin](https://github.com/PyO3/maturin).

To install:

```shell
pipx install maturin
```

To build wheels:
```shell
maturin build
```
This stores wheels in the `target/wheels` folder by default.

### Testing

Extra testing dependencies are installed via `poetry`:
```shell
poetry install
```



## TODO

- There is no good way to describe functions that accept interface (e.g. `Replica::new` accepts any of the storage implementations, but Python bindings lack such mechanisms), currently, `Replica::new` just constructs the SqliteStorage from the params passed into the constructor.
- It is possible to convert `WorkingSet` into a python iterator (you can iterate over it via `for item in <blah>:` or `next(<blah>)`), but that needs a way to store the current state.
- Possible integration with Github Workflows for deployment.
- Possible integration with Github Workflows for deployment to PyPI
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ name = "taskchampion-py"
version = "0.1.0"
authors = ["illyalaifu <[email protected]>"]
description = ""
package-mode = false

[tool.poetry.dependencies]
python = ">=3.8"
maturin = {extras = ["patchelf"], version = "^1.5.1"}
maturin = { extras = ["patchelf"], version = "^1.5.1" }

[tool.poetry.group.test.dependencies]
pytest = "^8.2.0"
Expand Down

0 comments on commit 1c73048

Please sign in to comment.