Skip to content

Commit

Permalink
Removing older requirements file
Browse files Browse the repository at this point in the history
  • Loading branch information
davide-f committed Dec 10, 2024
1 parent f73b195 commit 4c153fe
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 33 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,7 @@ The project's CLI is not using click because it is an external dependency. The g
│   ├── __main__.py # The entry point for the project
│   └── VERSION # The version for the project is kept in a static file
├── README.md # The main readme for the project
├── setup.py # The setup.py file for installing and packaging the project
├── requirements.txt # An empty file to hold the requirements for the project
├── requirements-test.txt # List of requirements for testing and devlopment
├── setup.py # The setup.py file for installing and packaging the project
├── pyproject.toml # Configuration file used by packaging tools
└── tests # Unit tests for the project (add mote tests files here)
├── conftest.py # Configuration, hooks and fixtures for pytest
├── __init__.py # This tells Python that this is a test package
Expand Down
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
include LICENSE
include HISTORY.md
include requirements
graft tests
graft earth_osm
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ show: ## Show the current environment.
.PHONY: install
install: ## Install the project in dev mode.
@echo "Don't forget to run 'make virtualenv' if you got errors."
$(ENV_PREFIX)pip install -e .[test]
$(ENV_PREFIX)pip install -e .[dev]

.PHONY: fmt
fmt: ## Format code using black & isort.
Expand Down Expand Up @@ -67,7 +67,7 @@ virtualenv: ## Create a virtual environment.
@rm -rf .venv
@python3 -m venv .venv
@./.venv/bin/pip install -U pip
@./.venv/bin/pip install -e .[test]
@./.venv/bin/pip install -e .[dev]
@echo
@echo "!!! Please run 'source .venv/bin/activate' to enable the environment !!!"

Expand All @@ -90,7 +90,7 @@ api-docs: ## Generate the API documentation.
echo "There are uncommitted changes. Stash or commit changes first"; \
else \
echo "Generating API documentation..."; \
$(ENV_PREFIX)pip install -r requirements-docs.txt; \
$(ENV_PREFIX)pip install -r .[docs]; \
$(ENV_PREFIX)lazydocs \
--output-path="./docs/api-docs" \
--overview-file="README.md" \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ To contribute to earth-osm, follow these steps:
3. Install the development dependencies:
```bash
pip install git+https://github.com/pypsa-meets-earth/earth-osm.git
pip install -r requirements-test.txt
pip install -r .[test]
```

4. Read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more detailed information on how to contribute to the project.
Expand Down
10 changes: 9 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Homepage = "https://github.com/pypsa-meets-earth/earth-osm/"
Issues = "https://github.com/pypsa-meets-earth/earth-osm/issues"

[project.optional-dependencies]
test = [
dev = [
"pytest",
"coverage",
"flake8",
Expand All @@ -46,6 +46,14 @@ test = [
"mkdocs",
"osmium",
]
docs = [
"lazydocs",
"mkdocs",
"mkdocs-material",
"mkdocs-awesome-pages-plugin",
"mkdocstrings[python]",
"markdown-include",
]

[console_scripts]
earth_osm = "earth_osm.__main__:main"
Expand Down
6 changes: 0 additions & 6 deletions requirements-docs.txt

This file was deleted.

12 changes: 0 additions & 12 deletions requirements-test.txt

This file was deleted.

5 changes: 0 additions & 5 deletions requirements.txt

This file was deleted.

0 comments on commit 4c153fe

Please sign in to comment.