Luke Murphy
4 years ago
1 changed files with 29 additions and 44 deletions
@ -1,66 +1,51 @@ |
|||
# Dropship |
|||
|
|||
[![Build Status](https://travis-ci.org/decentral1se/dropship.svg?branch=main)](https://travis-ci.org/decentral1se/dropship) |
|||
> Get Things From One Computer To Another, Safely |
|||
|
|||
Lets try magic wormhole with a nice graphical interface. |
|||
[Magic-wormhole](https://magic-wormhole.readthedocs.io/en/latest) with a nice graphical interface. |
|||
|
|||
![Screen cast of dropship interface](https://vvvvvvaria.org/~r/dropship0.1.gif) |
|||
|
|||
_(click for video)_ |
|||
|
|||
## Install |
|||
|
|||
> Coming Soon™ |
|||
|
|||
## Develop |
|||
|
|||
### Documentation |
|||
|
|||
See our [wiki](https://git.vvvvvvaria.org/rra/dropship/wiki). |
|||
## Features |
|||
|
|||
### Install for Hacking |
|||
- ??? |
|||
|
|||
Install [poetry](https://python-poetry.org/docs/#installation) and then install the package locally. |
|||
## Supported Languages |
|||
|
|||
``` |
|||
$ poetry install |
|||
``` |
|||
- English |
|||
|
|||
### Run in Hackity Hack Hack Mode |
|||
## System requirements |
|||
|
|||
```bash |
|||
$ poetry run dropship |
|||
``` |
|||
Dropship should work on the following distributions: |
|||
|
|||
### Updating dependencies |
|||
- Debian Stretch (9.0) |
|||
|
|||
- Change the bounds/versions/etc. in the [pyproject.toml](./pyproject.toml) |
|||
- Run `poetry update` |
|||
- Commit and push your changes |
|||
Other Linux distributions may work as well. We currently do not support MacOS or Windows. |
|||
|
|||
The [poetry.lock](./poetry.lock) file helps us all get the same dependencies. |
|||
Dropship requires the following system dependencies: |
|||
|
|||
### Adding a Github Mirror |
|||
- GTK+ |
|||
- Python > 3.6 |
|||
- PyGObject 3.30.5+ |
|||
- Cairo > 1.14 |
|||
|
|||
We use a Github mirror so we can have a [gratis automated release build](./.travis.yml). |
|||
|
|||
Add the following to the bottom of your `.git/config`. |
|||
|
|||
``` |
|||
[remote "all"] |
|||
url = ssh://gitea@vvvvvvaria.org:12345/rra/dropship.git |
|||
url = git@github.com:decentral1se/dropship.git |
|||
``` |
|||
|
|||
The `git push -u all main` will setup `git push` to automatically push to both remotes. |
|||
## Install |
|||
|
|||
### Make a new Release |
|||
[![PyPI version](https://badge.fury.io/py/dropship.svg)](https://badge.fury.io/py/dropship) |
|||
[![Build Status](https://travis-ci.org/decentral1se/dropship.svg?branch=main)](https://travis-ci.org/decentral1se/dropship) |
|||
|
|||
> Publishing binaries is disabled until we make further progress on [#3](https://git.vvvvvvaria.org/rra/dropship/issues/3) |
|||
<details><summary>Debian Stretch</summary> |
|||
<pre> |
|||
$ sudo apt install -y python3-gi python3-gi-cairo gir1.2-gtk-3.0 |
|||
$ python3 -m venv .venv |
|||
$ source .venv/bin/activate |
|||
$ pip install dropship |
|||
$ dropship # run in your command-line terminal |
|||
</pre> |
|||
</details> |
|||
|
|||
```bash |
|||
$ git tag $mytag # follow semver.org please |
|||
$ git push |
|||
``` |
|||
## Develop |
|||
|
|||
The [Travis CI configuration](./.travis.yml) will run [a build](https://travis-ci.org/github/decentral1se/dropship) and [publish binaries here](https://github.com/decentral1se/dropship/releases). |
|||
See our [wiki](https://git.vvvvvvaria.org/rra/dropship/wiki). |
|||
|
Loading…
Reference in new issue