Skip to content

Commit

Permalink
Set global python package install option as main
Browse files Browse the repository at this point in the history
  • Loading branch information
migueldemoura committed Aug 9, 2020
1 parent 046407b commit 4bb1f68
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Myazo is a self-hosted [Gyazo] alternative. It allows you to take a screenshot o

It is comprised by a cross-platform client in Python which defers the actual taking of screenshot to OS built-in tools (macOS and Windows) or common utilities (GNU/Linux distributions). The server script, designed with cheap shared hosting in mind, is written with the ubiquitous PHP. Both the client and server are single files. You may separate the settings from the code if you wish.

It can also function as a mere Gyazo client, uploading directly to Gyazo's servers. In that case, you simply need the client and to set the configuration option `gyazo_server` to `True`. This mode won't send additional metadata like the Gyazo proprietary clients.
It can also function as a mere Gyazo client, uploading directly to Gyazo's servers. In that case, you simply need the client and to set the configuration option `gyazo_server` to `True`. This mode won't send additional metadata like Gyazo's proprietary clients.

## Compatibility

### Client

* Python >= 3.5 (check with `python --version`)
* Python >= 3.6 (check with `python --version` or `python3 --version`)

The following OSes have off-the-shelf compatibility. You can add more back ends for missing systems or configurations.

Expand All @@ -29,11 +29,19 @@ The following OSes have off-the-shelf compatibility. You can add more back ends
* Install [Python] 3 and choose the version matching your CPU arch (x86 or x86-64);
* Install client requirements:

```shell
pip3 install -r requirements.txt
```

Alternatively, you can use poetry:

```shell
pip3 install poetry
cd client/ && poetry install
```

You'll have to ensure that the python script is then ran with `poetry run`.

* Choose or generate a secret key and fill in the variable `secret` at `client/src/myazo.py`;
* Hash the secret key with bcrypt and fill in the variable `secretBcrypt` at `server/src/upload.php`;
You can do so with PHP itself:
Expand Down Expand Up @@ -96,7 +104,7 @@ Make sure the file is executable by running `chmod +x /path/to/myazo.py`.

`~/.local/share/applications/myazo.desktop`

``` ini
```ini
[Desktop Entry]
Name=Myazo
Comment=Screenshot
Expand Down
3 changes: 3 additions & 0 deletions client/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
requests==2.24.0
pyperclip==1.8.0
pillow==7.2.0

0 comments on commit 4bb1f68

Please sign in to comment.