Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oracle/ocifs
ocifs provides a POSIX-compatible API wrapping Oracle Cloud Infrastructure's (OCI) Object Storage. ocifs is a python library that relies on the fsspec framework.
https://github.com/oracle/ocifs
cloud filesystem fsspec object-storage oci oracle python3
Last synced: about 2 months ago
JSON representation
ocifs provides a POSIX-compatible API wrapping Oracle Cloud Infrastructure's (OCI) Object Storage. ocifs is a python library that relies on the fsspec framework.
- Host: GitHub
- URL: https://github.com/oracle/ocifs
- Owner: oracle
- License: upl-1.0
- Created: 2022-01-30T19:12:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-25T17:15:37.000Z (3 months ago)
- Last Synced: 2024-07-08T07:34:30.278Z (2 months ago)
- Topics: cloud, filesystem, fsspec, object-storage, oci, oracle, python3
- Language: Python
- Homepage: https://ocifs.readthedocs.io/en/latest/
- Size: 135 KB
- Stars: 16
- Watchers: 9
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README-development.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - oracle/ocifs - ocifs provides a POSIX-compatible API wrapping Oracle Cloud Infrastructure's (OCI) Object Storage. ocifs is a python library that relies on the fsspec framework. (python3)
README
============
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:
.. code-block:: sh
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`__.
__ https://docs.cloud.oracle.com/Content/API/Concepts/sdkconfig.htm
Running Tests
=============
The SDK uses `pytest` as its test framework. If you want to run an individual test, then run:
.. code-block:: sh
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:
.. code-block:: sh
python3 -m pip install pre-commit
pre-commit install
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:
.. code-block:: sh
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:
.. code-block:: sh
pip install build
python -m build
This wheel can then be installed using `pip`.