# Solidipes
_Python package that aids the processes of curating, publishing, and sharing research data_
[](https://badge.fury.io/py/solidipes)
[](http://solidipes.readthedocs.io/)
See the package's documentation on [Read the Docs](http://solidipes.readthedocs.io/).
<img src="https://gitlab.com/solidipes/solidipes/-/raw/main/logos/solidipes.jpg" width="200px" height="200px">
# Installation
## As regular user
```bash
pip install solidipes
```
## As developer
If you intend to implement new features into the code (like implementing a new reader for a specific file format or a new type of report), you need to get the source code of Solidipes.
### Dependencies
- Python (3.8 minimum)
- make
- [Poetry](https://python-poetry.org/docs/#installation)
### Installation
```bash
git clone https://gitlab.com/solidipes/solidipes.git
cd solidipes
make install
```
This will install Solidipes as well as all the Python development dependencies. It will also fetch Solidipes plugins in the `plugins` directory.
## Build the documentation
### Dependencies
- [Graphviz](https://graphviz.org/download/)
### Build
Run the following command to build the documentation locally:
```bash
cd docs
make html
```
The documentation will be available in the `docs/build/html` directory.
# Usage from the command line
To see a list of all available commands, run
```bash
solidipes --help
```
Consult the documentation in the [Getting started](https://solidipes.readthedocs.io/en/latest/src/getting_started.html#usage-from-the-command-line) section for next steps.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/groups/dcsm",
"name": "solidipes",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9.12",
"maintainer_email": null,
"keywords": null,
"author": "Guillaume Anciaux",
"author_email": "guillaume.anciaux@epfl.ch",
"download_url": "https://files.pythonhosted.org/packages/8c/07/70b8426d668476f411f9c24edb136e3008a35a0b630a84524c115e10a59c/solidipes-1.1.0.tar.gz",
"platform": null,
"description": "# Solidipes\n\n_Python package that aids the processes of curating, publishing, and sharing research data_\n\n[](https://badge.fury.io/py/solidipes)\n[](http://solidipes.readthedocs.io/)\n\nSee the package's documentation on [Read the Docs](http://solidipes.readthedocs.io/).\n\n<img src=\"https://gitlab.com/solidipes/solidipes/-/raw/main/logos/solidipes.jpg\" width=\"200px\" height=\"200px\">\n\n\n# Installation\n\n## As regular user\n\n```bash\npip install solidipes\n```\n\n\n## As developer\n\nIf you intend to implement new features into the code (like implementing a new reader for a specific file format or a new type of report), you need to get the source code of Solidipes.\n\n\n### Dependencies\n\n- Python (3.8 minimum)\n- make\n- [Poetry](https://python-poetry.org/docs/#installation)\n\n\n### Installation\n\n```bash\ngit clone https://gitlab.com/solidipes/solidipes.git\ncd solidipes\nmake install\n```\n\nThis will install Solidipes as well as all the Python development dependencies. It will also fetch Solidipes plugins in the `plugins` directory.\n\n\n## Build the documentation\n\n### Dependencies\n\n- [Graphviz](https://graphviz.org/download/)\n\n\n### Build\n\nRun the following command to build the documentation locally:\n\n```bash\ncd docs\nmake html\n```\n\nThe documentation will be available in the `docs/build/html` directory.\n\n\n# Usage from the command line\n\nTo see a list of all available commands, run\n```bash\nsolidipes --help\n```\n\nConsult the documentation in the [Getting started](https://solidipes.readthedocs.io/en/latest/src/getting_started.html#usage-from-the-command-line) section for next steps.\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Python package that aids the processes of curating, publishing, and sharing research data",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://solidipes.readthedocs.io/en/latest/",
"Homepage": "https://gitlab.com/groups/dcsm",
"Repository": "https://gitlab.com/solidipes/solidipes"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abb9a37846a653d8dae7693df9435372110167af9f7519dc9d7669df9f94d086",
"md5": "10202fc141948b68d757def6c7fa2c63",
"sha256": "d5c9fd4bdd8f446f95aad7f4f53fe661b1a7fa87de825420ea195b2c6c2e031e"
},
"downloads": -1,
"filename": "solidipes-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10202fc141948b68d757def6c7fa2c63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9.12",
"size": 153421,
"upload_time": "2024-11-08T09:03:46",
"upload_time_iso_8601": "2024-11-08T09:03:46.744725Z",
"url": "https://files.pythonhosted.org/packages/ab/b9/a37846a653d8dae7693df9435372110167af9f7519dc9d7669df9f94d086/solidipes-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c0770b8426d668476f411f9c24edb136e3008a35a0b630a84524c115e10a59c",
"md5": "bc81218403e1ac2ff6633c4e4cb05f1b",
"sha256": "48547d4179b969e0c183df62e9c0f2681ff1d71412b5ef70337e26ae881ae991"
},
"downloads": -1,
"filename": "solidipes-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bc81218403e1ac2ff6633c4e4cb05f1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9.12",
"size": 133594,
"upload_time": "2024-11-08T09:03:48",
"upload_time_iso_8601": "2024-11-08T09:03:48.166402Z",
"url": "https://files.pythonhosted.org/packages/8c/07/70b8426d668476f411f9c24edb136e3008a35a0b630a84524c115e10a59c/solidipes-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 09:03:48",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "groups",
"gitlab_project": "dcsm",
"lcname": "solidipes"
}
JSON