Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve poetry file #384

Merged
merged 2 commits into from
Mar 7, 2024
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
49 changes: 29 additions & 20 deletions Cargo.lock

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

24 changes: 24 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Greenlight docs

The docs are hosted on https://blockstream.github.io/greenlight/

## Contributing to the documentation

You must have a working installation of `python` and `poetry` to contribute to the docs.

To install dependencies make sure you are at the root of the repository

```
poetry install --with-only docs
```

To build the docs

```
cd docs; mkdocs build
```

To serve the docs locally
```
cd docs; mkdocs serve
```
23 changes: 0 additions & 23 deletions docs/pyproject.toml

This file was deleted.

15 changes: 11 additions & 4 deletions libs/gl-testing/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ cryptography = ">=36.0.1,<37.0.0"
ephemeral-port-reserve = "^1.1.4"
sh = "^1.14.2"
pytest-timeout = "^2.1.0"
# `pip` doesn't like relative-path dependencies. Should be ok once we
# publish this on PyPI so pip can find it too.
# gl-client-py = {path = "../gl-client-py"}
pytest-xdist = "^2.5.0"
pytest = "^7.1.2"
pytest-cov = "^3.0.0"
Expand All @@ -30,7 +27,17 @@ anyio = "^3.7.1"
purerpc = { version = "^0.8.0", extras = ["grpc"] }
pytest-sugar = "^0.9.7"

[tool.poetry.dev-dependencies]
ErikDeSmedt marked this conversation as resolved.
Show resolved Hide resolved
# The dependency below is defined in this repository
# PyPi cannot support relative paths.
#
# Users, who `pip install` this library retrieve the sources from `PyPi`.
# using the version numbers listed below
#
# Contributors should use `poetry install` in the project root
# to insure the installation is editable from local sources.
gl-client = "^0.1.11"

[tool.poetry.group.dev.dependencies]
mypy = "^1"
typed-ast = "^1.5.4"

Expand Down
43 changes: 43 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[tool.poetry]
package-mode=false

[tool.poetry.dependencies]
python = ">=3.8,<4.0"
gl-client = {path = "./libs/gl-client-py", develop=true}
gltesting = {path = "./libs/gl-testing", develop=true}

[tool.poetry.group.dev.dependencies]
black = "^24.0.0"
pytest = "^7"

[tool.poetry.group.dev-gl-client-py.dependencies]
black = "^24.0.0"
mypy-protobuf = "^3.5"
maturin = ">=1.0,<1.3.2"
mypy = "^1.7.0"
grpcio-tools = "^1.59.2"

[tool.poetry.group.dev-gl-testing.dependencies]
mypy = "^1"
typed-ast = "^1.5.4"
grpc-stubs= "^1.53.0"

[tool.poetry.group.docs]
optional=true

[tool.poetry.group.docs.dependencies]
python = ">=3.8,<4"
mkdocs-material = "^9.1.0"
mkdocs-redirects = "^1.1.0"
mkdocs-material-extensions = "^1.3.1"
pymdown-extensions = "^10.7"
ghp-import = "2.1.0"
pdoc = "^13.1.1"
cairosvg = "^2.7.0"
pillow = "^9.5.0"

# Language server protocol used by the ide
# Not to be confused with lightning service provider
[tool.poetry.group.lsp_ide.dependencies]
python-lsp-server = "^1.10.0"

Loading