Skip to content

Commit

Permalink
Add GH badge
Browse files Browse the repository at this point in the history
  • Loading branch information
mar10 committed Apr 27, 2024
1 parent 2c4e981 commit 470b932
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 32 deletions.
33 changes: 16 additions & 17 deletions .github/workflows/python-app.yml
@@ -1,36 +1,35 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python application
name: Tests

on:
push:
branches: [ "master" ]
branches: ["master"]
pull_request:
branches: [ "master" ]
branches: ["master"]

permissions:
contents: read

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v3
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
# if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: TOX
run: |
tox
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v3
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
# if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: TOX
run: |
tox
# - name: Test with pytest
# run: |
# pytest
5 changes: 2 additions & 3 deletions CHANGELOG.md
Expand Up @@ -2,10 +2,9 @@

- Fix #82 Error importing SFTPTarget with paramiko > 3.0
- Drop support for Python 3.7 (end-of-life: 2023-06-27)
- Use GH Actions for CI instead of Travis

4.0.0 (2022-07-31)

---
## 4.0.0 (2022-07-31)

- Add SFTP support
- Improve `run` command
Expand Down
22 changes: 10 additions & 12 deletions README.md
@@ -1,5 +1,6 @@
# ![logo](https://raw.githubusercontent.com/mar10/pyftpsync/master/docs/logo_48x48.png) pyftpsync
[![Build Status](https://travis-ci.com/mar10/pyftpsync.svg?branch=master)](https://app.travis-ci.com/github/mar10/pyftpsync)

[![Tests](https://github.com/mar10/pyftpsync/actions/workflows/python-app.yml/badge.svg)](https://github.com/mar10/pyftpsync/actions/workflows/python-app.yml)
[![Latest Version](https://img.shields.io/pypi/v/pyftpsync.svg)](https://pypi.python.org/pypi/pyftpsync/)
[![License](https://img.shields.io/pypi/l/pyftpsync.svg)](https://github.com/mar10/pyftpsync/blob/master/LICENSE.txt)
[![Documentation Status](https://readthedocs.org/projects/pyftpsync/badge/?version=latest)](https://pyftpsync.readthedocs.io/)
Expand All @@ -11,20 +12,18 @@
[ ![sample](teaser.png?raw=true) ](https://github.com/mar10/pyftpsync "Live demo")


## Summary

Synchronize directories using FTP(S), SFTP, or file system access.

* This is a command line tool...
* ... and a library for use in your Python projects.
* Upload, download, and bi-directional synch mode.
* Allows FTP-to-FTP and Filesystem-to-Filesystem synchronization as well.
* Architecture is open to add other target types.
- This is a command line tool...
- ... and a library for use in your Python projects.
- Upload, download, and bi-directional synch mode.
- Allows FTP-to-FTP and Filesystem-to-Filesystem synchronization as well.
- Architecture is open to add other target types.

**Note:** Version 4.0 drops support for Python 2.


## Quickstart

[Python](https://www.python.org/download/Python) 3.7+ is required,
Expand All @@ -44,19 +43,18 @@ using the Windows Package Manager:
> winget install pyftpsync
```

See [Command Line Interface](https://pyftpsync.readthedocs.io/en/latest/ug_cli.html)
See [Command Line Interface](https://pyftpsync.readthedocs.io/en/latest/ug_cli.html)
for details.

In addition to the direct invocation of `upload`, `download`, or `sync`
commands, version 3.x allows to define a ``pyftpsync_yaml`` file
commands, version 3.x allows to define a `pyftpsync_yaml` file
in your project's root folder which then can be executed like so::

$ pyftpsync run

See [Run from pyftpsync.yaml](https://pyftpsync.readthedocs.io/en/latest/ug_run.html)
See [Run from pyftpsync.yaml](https://pyftpsync.readthedocs.io/en/latest/ug_run.html)
for details.


## Documentation

[Read the Docs](https://pyftpsync.readthedocs.io/) for details.

0 comments on commit 470b932

Please sign in to comment.