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.4.0.tar.gz
(7.1 kB
view details)
Built Distribution
File details
Details for the file BrickFTP-0.4.0.tar.gz
.
File metadata
- Download URL: BrickFTP-0.4.0.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a37200f716d0c00b4f7577f17fc9bc43c7dcd7e1652f43179c50235f212c6bfa |
|
MD5 | a33b1b645280a6ac64b8e9c23e35d16a |
|
BLAKE2b-256 | bcdcad6dab0dac006f66771fbc9e6bbfa067e939de790a72883248ec052700b8 |
File details
Details for the file BrickFTP-0.4.0-py2.py3-none-any.whl
.
File metadata
- Download URL: BrickFTP-0.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 3.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4162aa014aa9aea341f51ba06a4e9e0f4bea0ce266510c8d1c43aadd1c0b083 |
|
MD5 | 1c879c551ec4ad284121cd2adcfb1129 |
|
BLAKE2b-256 | 98584c9c8e285b98cbab04e6110cea9839ccc39c7509193d142383224d1417ca |