Skip to content

Commit

Permalink
Publish to PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
Emrys-Merlin committed Sep 7, 2024
1 parent 2365876 commit bcd8368
Show file tree
Hide file tree
Showing 4 changed files with 1,159 additions and 4 deletions.
18 changes: 18 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,21 @@ run-ci:
.PHONY: docs
docs:
mkdocs gh-deploy

.PHONY: clean
clean:
rm -rf site
rm -rf dist

.PHONY: build
build:
uv build

# Needs different credentials
# .PHONY: publish-test
# publish-test:
# uvx twine upload --repository testpypi dist/*

.PHONY: publish
publish:
uvx twine upload dist/*
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ This python package is a framework around [Playwright](https://Playwright.dev/py
## Installation

Currently, the package is only available on github. You can manually install it via:
The package is available via PyPI. You can install it via
```
pip install web_watchr
```
If you prefer the latest changes, you can also install it directly from the repository via:
```
pip install git+https://github.com/actions/setup-python
```
I am currently working on publishing the package on PyPI.

## Usage

Expand Down Expand Up @@ -102,7 +105,7 @@ Running the script will now send updates to your phone via telegram!

## Documentation

So far, almost all of the documentation is restricted to this readme. However, you can have a look at the [API Reference](https://emrys-merlin.github.io/website_monitoring_bot/api).
So far, almost all of the documentation is restricted to this readme. However, you can have a look at the [API Reference](https://emrys-merlin.github.io/web_watchr/api).

## Contribution

Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ license = { text = "MIT" }
classifiers = ["Programming Language :: Python :: 3"]
dependencies = [
"python-telegram-bot==21.1",
"typer==0.12.3",
"pydantic==2.7.0",
"loguru==0.7.2",
"playwright==1.46.0",
Expand Down
Loading

0 comments on commit bcd8368

Please sign in to comment.