feat(repo): Rename Aqueductpy to Pyaqueduct everywhere in the repo (#2)

* rename aqueductpy to pyaqueduct everywhere in the repo.

* add project urls to the toml file for PyPi.

* update version of the python package.

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-	"name": "Aqueductpy Dev Container",
+	"name": "PyAqueduct Dev Container",
 	"context": "..",
 	"dockerFile": "../containers/Dockerfile",
 	"customizations": {

.github/workflows/release.yaml

@@ -1,10 +1,10 @@
-name: Release Aqueductpy
+name: Release PyAqueduct
 
 on:
   workflow_dispatch:
     inputs:
       version:
-        description: "Aqueductpy Version"
+        description: "PyAqueduct Version"
         required: true
         type: string
         default: "MAJOR.MINOR.PATCH"
@@ -38,5 +38,5 @@ jobs:
           tag: ${{ inputs.version }}
           name: "${{ inputs.version }}"
           allowUpdates: true
-          artifacts: "dist/aqueductpy-*.tar.gz"
+          artifacts: "dist/pyaqueduct-*.tar.gz"
           token: ${{ secrets.GITHUB_TOKEN }}

.vscode/settings.json

@@ -36,6 +36,6 @@
         "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
     ],
     "cSpell.words": [
-        "Aqueductpy"
+        "PyAqueduct"
     ]
 }

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Welcome to the Aqueduct Project
+
+Thank you for contributing to Aqueduct. We welcome contributions via 
+[New Issues](#new-issues), 
+[Pull Requests](#pull-requests), and
+[Feature Requests](#feature-requests). 
+
+Please read the [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) we use and sign a [CLA](#contributor-license-agreement-cla) before submitting contributions. 
+
+# New Issues
+
+If you find something wrong or broken, please file an issue with label `new-issue`. Please include a minimum explanation for how to repro your issue. At the very least include:
+
+1. Current dev environment (OS version, Tools version, Aqueduct version). 
+
+2. Steps to reproduce the bug. 
+
+Your bug will be triaged (`answer-in-docs`, `already-filed`, `new bug`) and moved forward.
+
+# Pull Requests
+
+Please start off by opening an issue or adding to the discussion of an existing one. That way, we’re all on the same page before your PR lands. 
+
+Several things to make it easier for us to accept your PR:
+
+1. Tackle one bug or feature at a time. 
+
+2. Keep to the coding style and conventions already there. 
+
+3. Don't break anything!
+
+The reviewers will then work with you to get your idea in to main.
+
+# Feature Requests
+
+We’re keen to hear your ideas for improving and extending Aqueduct. Please file an issue with label `feature-request`.  We will triage all ideas with respect to Aqueduct’s roadmap and resources. 
+
+# Contributor License Agreement (CLA)
+
+## Individual contribution
+You need to sign a Contributor License Agreement (CLA) to accept your pull request. You only need to do this once. If you submit a pull request for the first time, please get in touch with us at aqueduct@riverlane.com. Put "CLA Individual" in the Subject: line. 
+
+## Company contribution
+If you make contributions to our repositories on behalf of your company, we will need a Corporate Contributor License Agreement (CLA) signed. To do that, please get in touch with us at aqueduct@riverlane.com. Put "CLA Corporate" in the Subject: line.

README.md

@@ -1,7 +1,23 @@
-# Aqueduct Python Client Library
+# PyAqueduct: Aqueduct Python Client Library
 
 Aqueduct is a versatile experiment management system designed to streamline and simplify quantum system administration. Automation, data management and a multi-user platform come together to facilitate demanding experimental activities, through an intuitive, consistent, open interface. With robust security features including role-based access control and authentication, Aqueduct ensures data integrity and accessibility throughout the experiment pipeline.
 
 Aqueduct is an extensible platform, with a full API allowing connectivity with external systems, and a plugin SDK allowing extensions to expand core Aqueduct functionality in a flexible and secure way. This first version of Aqueduct contains data management tools that augment a lab’s existing data storage systems by tracking critical settings, raw data and processed data from experiments, keeping them organised and readily accessible. Through convenient features such as tagging, favouriting, archiving, and annotation of experimental data, we facilitate a smoother data workflow for all labs. Aqueduct’s software APIs make it possible to retrofit existing experiment scripts so that all the lab’s data, not just the data produced by Deltaflow.Control, can be saved and accessed in a single, centralized location.
 
-This functionality is faciliated through 2 components: `aqueductcore` is  the server software that hosts the main application, web interface, and handles data storage. `aqueductpy` is our python client which allows easy creation of experiments and upload of data and metadata for them.
+This functionality is faciliated through 2 components: `aqueductcore` is  the server software that hosts the main application, web interface, and handles data storage. `pyaqueduct` is our python client which allows easy creation of experiments and upload of data and metadata for them.
+
+## Installation
+
+You can install PyAqueduct releases from PyPi:
+
+```bash
+pip install pyaqueduct
+```
+
+## Contributing
+
+Aqueduct is an open-source project, and we greatly value all contributions. Contributions are not limited to coding; you can also help by filing issues to report bugs, enhancing our documentation, or requesting new features. We strongly recommend using the templates provided for each of these tasks. If you’re interested in contributing, please refer to our [contribution guide](/CONTRIBUTING.md) for more information. We really appreciate your consideration for contributing to Aqueduct.
+
+## License
+
+This project is licensed under the MIT License - see the [MIT](/LICENSE) file for details

docs/api-reference.md

@@ -3,15 +3,15 @@ title: Python API Reference
 summary: Covers how to install the software.
 ---
 
-::: aqueductpy.API
+::: pyaqueduct.API
     options:
       show_source: false
       heading_level: 2
       show_bases: false
       show_root_heading: true
 
 
-::: aqueductpy.experiment.Experiment
+::: pyaqueduct.experiment.Experiment
     options:
         show_source: false
         heading_level: 2

docs/index.md

@@ -2,4 +2,4 @@ Aqueduct is a versatile experiment management system designed to streamline and
 
 Aqueduct is an extensible platform, with a full API allowing connectivity with external systems, and a plugin SDK allowing extensions to expand core Aqueduct functionality in a flexible and secure way. This first version of Aqueduct contains data management tools that augment a lab’s existing data storage systems by tracking critical settings, raw data and processed data from experiments, keeping them organised and readily accessible. Through convenient features such as tagging, favouriting, archiving, and annotation of experimental data, we facilitate a smoother data workflow for all labs. Aqueduct’s software APIs make it possible to retrofit existing experiment scripts so that all the lab’s data, not just the data produced by Deltaflow.Control, can be saved and accessed in a single, centralized location.
 
-This functionality is faciliated through 2 components: `aqueductcore` is  the server software that hosts the main application, web interface, and handles data storage. `aqueductpy` is our python client which allows easy creation of experiments and upload of data and metadata for them.
+This functionality is faciliated through 2 components: `aqueductcore` is  the server software that hosts the main application, web interface, and handles data storage. `pyaqueduct` is our python client which allows easy creation of experiments and upload of data and metadata for them.

examples/tutorial_notebook.ipynb

@@ -4,9 +4,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Aqueductpy Application Programming Interface (API) Tutorial\n",
+    "# PyAqueduct Application Programming Interface (API) Tutorial\n",
     "\n",
-    "In this tutorial, the API of Aqueductpy is introduced by working on a sample experiment. The sample experiment generates some results in the form of different files such as CSV, JSON, HDF5, and image files. Each execution of the experiment generates new set of files and therefore, is treated as a new experiment run."
+    "In this tutorial, the API of PyAqueduct is introduced by working on a sample experiment. The sample experiment generates some results in the form of different files such as CSV, JSON, HDF5, and image files. Each execution of the experiment generates new set of files and therefore, is treated as a new experiment run."
    ]
   },
   {
@@ -137,7 +137,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from aqueductpy import API\n",
+    "from pyaqueduct import API\n",
     "\n",
     "api = API(\"[AQUEDUCT_SERVER_URL_PLACE_HOLDER]\", timeout=1)\n",
     "\n",

mkdocs.yaml

@@ -1,7 +1,7 @@
 site_name: Aqueduct Python Client
 site_author: Riverlane Ltd.
-site_url: https://aqueducthub.github.io/aqueductpy/
-repo_name: aqueducthub/aqueductpy
+site_url: https://aqueducthub.github.io/pyaqueduct/
+repo_name: aqueducthub/pyaqueduct
 docs_dir: "docs"
 theme:
   name: material
@@ -60,7 +60,7 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          paths: [aqueductpy]
+          paths: [pyaqueduct]
 
 nav:
   - "index.md"