[doc] add Pipfile used by Cloudflare Pages build process
Browse files- .gitignore +1 -0
- Pipfile +30 -0
- README.md +6 -1
.gitignore
CHANGED
|
@@ -271,3 +271,4 @@ fabric.properties
|
|
| 271 |
|
| 272 |
# Sonarlint plugin
|
| 273 |
.idea/sonarlint
|
|
|
|
|
|
| 271 |
|
| 272 |
# Sonarlint plugin
|
| 273 |
.idea/sonarlint
|
| 274 |
+
/.idea/modules.xml
|
Pipfile
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[[source]]
|
| 2 |
+
url = "https://pypi.org/simple"
|
| 3 |
+
verify_ssl = true
|
| 4 |
+
name = "pypi"
|
| 5 |
+
|
| 6 |
+
[packages]
|
| 7 |
+
aws-lambda-powertools = "*"
|
| 8 |
+
awslambdaric = "*"
|
| 9 |
+
bson = "*"
|
| 10 |
+
geopandas = "*"
|
| 11 |
+
jmespath = "*"
|
| 12 |
+
numpy = "*"
|
| 13 |
+
onnxruntime = "*"
|
| 14 |
+
opencv-python-headless = "*"
|
| 15 |
+
pillow = "*"
|
| 16 |
+
pydantic = ">=2.0.3"
|
| 17 |
+
python-dotenv = "*"
|
| 18 |
+
rasterio = "*"
|
| 19 |
+
requests = "*"
|
| 20 |
+
sphinx = "*"
|
| 21 |
+
sphinx-autodoc-typehints = "*"
|
| 22 |
+
|
| 23 |
+
[dev-packages]
|
| 24 |
+
matplotlib = "*"
|
| 25 |
+
pytest = "*"
|
| 26 |
+
pytest-cov = "*"
|
| 27 |
+
|
| 28 |
+
[requires]
|
| 29 |
+
python_version = "3.11"
|
| 30 |
+
python_full_version = "3.11.6"
|
README.md
CHANGED
|
@@ -56,6 +56,11 @@ curl -X 'POST' \
|
|
| 56 |
3. It's possible to publish a new aws lambda version from cmd or from lambda page
|
| 57 |
|
| 58 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 59 |
## Tests
|
| 60 |
|
| 61 |
Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests.
|
|
@@ -87,4 +92,4 @@ cd docs && make html && ../
|
|
| 87 |
cd docs && make clean html && cd ../
|
| 88 |
```
|
| 89 |
|
| 90 |
-
The static documentation it's now ready at the path `_build/html/index.html`.
|
|
|
|
| 56 |
3. It's possible to publish a new aws lambda version from cmd or from lambda page
|
| 57 |
|
| 58 |
|
| 59 |
+
## Dependencies installation and local tests
|
| 60 |
+
The docker build process needs only the classic requirements.txt, instead for local development and sphinx-docs build
|
| 61 |
+
there is `Pipfile` (sphinx docs is hosted on Cloudflare Pages).
|
| 62 |
+
|
| 63 |
+
|
| 64 |
## Tests
|
| 65 |
|
| 66 |
Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests.
|
|
|
|
| 92 |
cd docs && make clean html && cd ../
|
| 93 |
```
|
| 94 |
|
| 95 |
+
The static documentation it's now ready at the path `docs/_build/html/index.html`.
|