{"id":13542661,"url":"https://github.com/oracle/ocifs","last_synced_at":"2025-04-09T16:04:37.633Z","repository":{"id":38819031,"uuid":"453776281","full_name":"oracle/ocifs","owner":"oracle","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-18T22:13:01.000Z","size":169,"stargazers_count":20,"open_issues_count":6,"forks_count":9,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-09T16:04:28.485Z","etag":null,"topics":["cloud","filesystem","fsspec","object-storage","oci","oracle","python3"],"latest_commit_sha":null,"homepage":"https://ocifs.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README-development.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-30T19:12:41.000Z","updated_at":"2025-04-04T04:32:28.000Z","dependencies_parsed_at":"2023-01-22T02:32:40.582Z","dependency_job_id":"fd799a09-e0f2-4ee1-9366-cb7503b097b3","html_url":"https://github.com/oracle/ocifs","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.125,"last_synced_commit":"47327acef7004af592c3fe8e270388aadc6ea550"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Focifs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Focifs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Focifs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Focifs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/ocifs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065290,"owners_count":21041871,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","filesystem","fsspec","object-storage","oci","oracle","python3"],"created_at":"2024-08-01T10:01:14.114Z","updated_at":"2025-04-09T16:04:37.612Z","avatar_url":"https://github.com/oracle.png","language":"Python","funding_links":[],"categories":["Python","python3"],"sub_categories":[],"readme":"============\nDevelopment\n============\n\nThe target audience for this README is developers wanting to contribute to ocifs, Oracle\nCloud Infrastructure (OCI) Object Storage implementation of fsspec's filesystem.\nIf you want to use the SDK with your own programs, see README.md.\n\nGetting Started\n===============\nAssuming that you have Python and `conda` installed, set up your environment and install the required dependencies like this:\n\n.. code-block:: sh\n\n    git clone https://github.com/oracle/ocifs.git\n    cd ocifs\n    conda create python=3.8 --name ocifs -y\n    conda activate ocifs\n    # Install the current package in your environment in an editable mode:\n    python3 -m pip install -e .\n\nYou should also set up your configuration files, see the `SDK and CLI Configuration File`__.\n\n__ https://docs.cloud.oracle.com/Content/API/Concepts/sdkconfig.htm\n\nRunning Tests\n=============\nThe SDK uses `pytest` as its test framework. If you want to run an individual test, then run:\n\n.. code-block:: sh\n\n    python -m pytest ocifs/tests/test_spec.py::test_simple\n\n\nSpecifying environment variables\n--------------------------------\nIn addition to a valid config file for your tenancy, the tests also require the following environment\nvariables to be set:\n\n    * ``OCIFS_TEST_NAMESPACE``: The namespace of a bucket in Object Storage to use for testing.\n    * ``OCIFS_TEST_BUCKET``: The bucket in Object Storage to use for testing.\n\n\nChecking Style\n==============\nThe ocifs SDK adheres to PEP8 style guilds, and uses Flake8 to validate style. There are some exceptions and they can\nbe viewed in the ``setup.cfg`` file.\n\nThere is a pre-commit hook setup for this repo. To use this pre-commit hook, run the following:\n\n.. code-block:: sh\n    python3 -m pip install pre-commit\n    pre-commit install\n\n\nSigning Commits\n================\nPlease ensure that all commits are signed following the process outlined here:\nhttps://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits\n\n\nGenerating Documentation\n========================\nSphinx is used for documentation. You can generate HTML locally with the following:\n\n.. code-block:: sh\n\n    python3 -m pip install -r docs/requirements.txt\n    cd docs\n    make html\n\nGenerating the wheel\n====================\nThe SDK using [build](https://pypa-build.readthedocs.io/en/stable/index.html) as build frontend. To generate sdist and wheel, you can run:\n\n.. code-block:: sh\n\n    pip install build\n    python -m build\n\nThis wheel can then be installed using `pip`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Focifs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Focifs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Focifs/lists"}