Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.47 KB

README-development.rst

File metadata and controls

81 lines (55 loc) · 2.47 KB
Raw

Development

The target audience for this README is developers wanting to contribute to ocifs, Oracle Cloud Infrastructure (OCI) Object Storage implementation of fsspec's filesystem. If you want to use the SDK with your own programs, see README.md.

Getting Started

Assuming that you have Python and conda installed, set up your environment and install the required dependencies like this:

git clone https://github.com/oracle/ocifs.git
cd ocifs
conda create python=3.8 --name ocifs -y
conda activate ocifs
# Install the current package in your environment in an editable mode:
python3 -m pip install -e .

You should also set up your configuration files, see the SDK and CLI Configuration File.

Running Tests

The SDK uses pytest as its test framework. If you want to run an individual test, then run:

python -m pytest ocifs/tests/test_spec.py::test_simple

Specifying environment variables

In addition to a valid config file for your tenancy, the tests also require the following environment variables to be set:

  • OCIFS_TEST_NAMESPACE: The namespace of a bucket in Object Storage to use for testing.
  • OCIFS_TEST_BUCKET: The bucket in Object Storage to use for testing.

Checking Style

The ocifs SDK adheres to PEP8 style guilds, and uses Flake8 to validate style. There are some exceptions and they can be viewed in the setup.cfg file.

There is a pre-commit hook setup for this repo. To use this pre-commit hook, run the following:

Signing Commits

Please ensure that all commits are signed following the process outlined here: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

Generating Documentation

Sphinx is used for documentation. You can generate HTML locally with the following:

python3 -m pip install -r docs/requirements.txt
cd docs
make html

Generating the wheel

The SDK using [build](https://pypa-build.readthedocs.io/en/stable/index.html) as build frontend. To generate sdist and wheel, you can run:

pip install build
python -m build

This wheel can then be installed using pip.