summaryrefslogtreecommitdiff
path: root/cli
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-10-15 16:30:30 -0700
committerMicah Lee <micah@micahflee.com>2020-10-15 16:30:30 -0700
commit5b2fe2019cdcfa6cedb844b5796133d3776dcf47 (patch)
treea92df0e293d4beb772e8165f2123803bb49cd508 /cli
parent50e7471a49600c1788cc823a07781e724137a93c (diff)
downloadonionshare-5b2fe2019cdcfa6cedb844b5796133d3776dcf47.tar.gz
onionshare-5b2fe2019cdcfa6cedb844b5796133d3776dcf47.zip
Make onionshare_cli an actual dependency of the GUI version
Diffstat (limited to 'cli')
-rw-r--r--cli/README.md20
-rw-r--r--cli/pyproject.toml2
2 files changed, 15 insertions, 7 deletions
diff --git a/cli/README.md b/cli/README.md
index d7858404..cb5f9bc5 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -27,13 +27,13 @@ First, make sure you have `tor` installed. In Linux, install it through your pac
Then install OnionShare CLI:
-```
+```sh
pip install onionshare-cli
```
Then run it with:
-```
+```sh
onionshare-cli --help
```
@@ -43,25 +43,33 @@ You must have python3 and [poetry](https://python-poetry.org/) installed.
Install dependencies with poetry:
-```
+```sh
poetry install
```
To run from the source tree:
-```
+```sh
poetry run onionshare-cli
```
To run tests:
-```
+```sh
poetry run pytest -v ./tests
```
+## Build a wheel package
+
+```sh
+poetry build
+```
+
+This will create `dist/onionshare_cli-$VERSION-py3-none-any.whl`.
+
### Making a release
-Before making a release, make update the version in these places:
+Before making a release, update the version in these places:
- `pyproject.toml`
- `onionshare_cli/resources/version.txt`
diff --git a/cli/pyproject.toml b/cli/pyproject.toml
index 4e68e2fd..576444ae 100644
--- a/cli/pyproject.toml
+++ b/cli/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "onionshare_cli"
-version = "0.1.3"
+version = "2.3.dev1"
description = "OnionShare lets you securely and anonymously send and receive files. It works by starting a web server, making it accessible as a Tor onion service, and generating an unguessable web address so others can download files from you, or upload files to you. It does _not_ require setting up a separate server or using a third party file-sharing service."
authors = ["Micah Lee <micah@micahflee.com>"]
license = "GPLv3+"