Skip to content

Commit

Permalink
Merge pull request #572 from neerdoc/dev-install
Browse files Browse the repository at this point in the history
Dev-install target.
  • Loading branch information
jacebrowning committed May 13, 2022
2 parents f40dbaf + db0c321 commit fe1af6a
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 2 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,17 @@ Build the documentation:
$ make docs
```

Local install for external testing:

```sh
$ make dev-install
```

Clean everything:
```sh
$ make clean
```

## Automatic

Keep all of the above tasks running on change:
Expand Down
11 changes: 10 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ ci: format check test mkdocs demo ## Run all tasks that determine CI status
dev: install .clean-test ## Continuously run all CI tasks when files chanage
poetry run sniffer

.PHONY: dev-install
dev-install: install
poetry build
pip install --force dist/doorstop*.whl

.PHONY: run ## Start the program
run: install
poetry run python $(PACKAGE)/gui/main.py
Expand Down Expand Up @@ -221,7 +226,7 @@ upload: dist ## Upload the current version to PyPI
# CLEANUP #####################################################################

.PHONY: clean
clean: .clean-build .clean-docs .clean-test .clean-install ## Delete all generated and temporary files
clean: .clean-dev-install .clean-build .clean-docs .clean-test .clean-install ## Delete all generated and temporary files

.PHONY: clean-all
clean-all: clean
Expand All @@ -232,6 +237,10 @@ clean-all: clean
find $(PACKAGES) -name '__pycache__' | xargs rm -rf
rm -rf *.egg-info

.PHONY: .clean-dev-install
.clean-dev-install:
pip uninstall --yes dist/doorstop*.whl

.PHONY: .clean-test
.clean-test:
rm -rf .cache .pytest .coverage htmlcov
Expand Down
1 change: 0 additions & 1 deletion poetry.lock

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

5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ classifiers = [
"Topic :: Text Processing :: Markup",
]

# Set files that should be excluded from distribution.
exclude = [
"**/tests/**"
]

[tool.poetry.dependencies]

python = "^3.7"
Expand Down

0 comments on commit fe1af6a

Please sign in to comment.