[36] prepare packaging for initial release

.github/workflows/linter-ruff.yml

@@ -0,0 +1,11 @@
+name: linter-ruff
+
+on: pull_request
+
+defaults:
+    run:
+        shell: bash
+
+jobs:
+    ruff-lint:
+        uses: irods/irods_reusable_github_workflows/.github/workflows/linter-irods-ruff.yml@main

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, The University of North Carolina at Chapel Hill
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -4,21 +4,24 @@ This is a Python wrapper for the [iRODS HTTP API](https://github.com/irods/irods
 
 Documentation for the endpoint operations can be found [here](https://github.com/irods/irods_client_http_api/blob/main/API.md).
 
-## Setup
-**NOTICE:** This project is not yet available through pip. To use, clone the repository into the desired location.
+## Install
+
+This wrapper is available via pip:
+
 ```
-git clone https://github.com/irods/irods_client_http_python.git
+pip install irods-http-client
 ```
+
 ## Usage
 To use the wrapper, follow the steps listed below.
 
 ```py
-from irods_client import IrodsClient
+from irods_http_client import IRODSHTTPClient
 
 # Create an instance of the wrapper with the base url of the iRODS server to
 # be accessed. <host>, <port>, and <version> are placeholders, and need
 # to be replaced by appropriate values.
-api = IrodsClient('http://<host>:<port>/irods-http-api/<version>')
+api = IRODSHTTPClient('http://<host>:<port>/irods-http-api/<version>')
 
 # Most endpoint operations require a user to be authenticated in order to
 # be executed. Authenticate with a username and password, and store the

irods_http_client/__init__.py

@@ -1 +1,3 @@
-from .irodsHttpClient import IrodsHttpClient
+"""iRODS HTTP client library for Python."""
+
+from .irods_http_client import IRODSHTTPClient as IRODSHTTPClient