Skip to main content

Python Client for BrickFTP API (

Project description


|PyPI| |Python Versions| |Build Status|

Python Client for BrickFTP API (
This client does not implement all the features of the API, pull requests are very welcome to expand functionality.


To install brickftp, simply:

.. code:: bash

pip install brickftp

How To Use

Initialise the client

.. code:: python

from brickftp import BrickFTP
client = BrickFTP(

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


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


Create a folder

.. code:: python




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

.. |PyPI| image::
.. |Python Versions| image::
.. |Build Status| image::

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)

Uploaded source

Built Distribution

BrickFTP-0.5.1-py2.py3-none-any.whl (3.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page