Python Client for BrickFTP API (https://developers.brickftp.com/).
Project description
BrickFTP
=======
|PyPI| |Python Versions| |Build Status|
Python Client for BrickFTP API (https://developers.brickftp.com/).
This client does not implement all the features of the API, pull requests are very welcome to expand functionality.
Installation
------------
To install brickftp, simply:
.. code:: bash
pip install brickftp
How To Use
----------
Initialise the client
~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from brickftp import BrickFTP
client = BrickFTP(
username='bob@example.com',
password='password123',
subdomain='subdomain',
)
Available methods
~~~~~~~~~~~~~~~~~
NOTE: For each client method, if there is a negative response from the API then ``BrickFTPError`` will raise.
List the contents of a folder
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
client.dir('/some_remote/path')
Upload a file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Upto 5MB supported by the client at this time.
.. code:: python
client.upload(upload_path='/some/path.txt', local_path='path.txt')
Download a file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
client.download_file(remote_path='/some/path.txt', local_path='path.txt')
Delete a file or folder
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
NOTE: Deletes recursively through subdirectories.
.. code:: python
client.delete('/some_remote/path')
Create a folder
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
client.mkdir('/some_remote/path')
Requirements
------------
::
1. Python 3.6+
2. See requirements.txt
Running the tests
-----------------
Set the environment variables: ``BRICK_FTP_USER``, ``BRICK_FTP_PASS``, ``BRICK_FTP_SUBDOMAIN``.
NOTE: Running the tests against a BrickFTP user will wipe all data on their account.
.. code:: bash
pip install -r requirements-test.txt
pytest
.. |PyPI| image:: https://img.shields.io/pypi/v/BrickFTP.svg
:target: https://pypi.python.org/pypi/BrickFTP
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/BrickFTP.svg
:target: https://pypi.python.org/pypi/BrickFTP
.. |Build Status| image:: https://travis-ci.org/Usio-Energy/BrickFTP.png?branch=master
:target: https://travis-ci.org/Usio-Energy/BrickFTP
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
BrickFTP-0.5.1.tar.gz
(7.3 kB
view hashes)
Built Distribution
Close
Hashes for BrickFTP-0.5.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 130af6a405818dd33e59690eaa23852ca40efbda39fce0cc84e2913f783c4779 |
|
MD5 | 9a93c46d65454541303cec73360afe3e |
|
BLAKE2b-256 | 67a734d092d82626ef7db8c0b74460416b42c8243ad4881d4dbd442f1cc32660 |