Metadata-Version: 2.1
Name: dsp-tools
Version: 1.1.6
Summary: A Python library and tools for the DaSCH Service Platform
Home-page: https://github.com/dasch-swiss/dsp-tools
Author: Lukas Rosenthaler
Author-email: lukas.rosenthaler@dasch.swiss
License: GPLv3
Description: [![PyPI version](https://badge.fury.io/py/dsp-tools.svg)](https://badge.fury.io/py/dsp-tools)
        
        # DSP-TOOLS - DaSCH Service Platform Tools
        
        dsp-tools is a command line tool that helps you interact with the DaSCH Service Platform server (DSP server).
        
        Go to [Full Documentation](https://dasch-swiss.github.io/dsp-tools/)
        
        ## Information for developers
        
        There is a `Makefile` for all the following tasks (and more). Type `make` to print the available targets.
        
        ## Install from source
        
        To install from source run:
        ```bash
        python3 setup.py install
        ```
        
        ## Install the requirements
        
        To install the requirements run:
        
        ```bash
        pip3 install -r requirements.txt
        ```
        
        To generate a requirements file (usually requirements.txt), that you commit with your project, run:
        
        ```bash
        pip3 freeze > requirements.txt
        ```
        
        ## Testing
        Please note that testing requires launching the complete DSP API stack which is based on docker images. Therefore, we
        recommend installing the [docker desktop client](https://www.docker.com/products).
        
        To run the complete test suite:
        
        ```bash
        make test
        ```
        
        ## Publishing
        
        Publishing is automated with GitHub Actions and should _not_ be done manually. Please follow the
        [Pull Request Guidelines](https://docs.dasch.swiss/developers/dsp/contribution/#pull-request-guidelines). If done
        correctly, when merging a pull request into `main`, the `release-please` action will create or update a pull request for
        a release. This pull request will follow semantic versioning and update the change log. Once all desired features are
        merged, the release can be executed by merging this release pull request into `main`. This will trigger actions that
        create a release on GitHub, on PyPI and the docs.
        
        Please ensure you have only one pull request per feature.
        
        ## Publishing manually
        
        Publishing is automated with GitHub Actions and should _not_ be done manually. If you still need to do it, follow the
        steps below.
        
        Generate the distribution package. Make sure you have the latest versions of `setuptools` and `wheel` installed:
        
        ```bash
        python3 -m pip install --upgrade pip setuptools wheel
        python3 setup.py sdist bdist_wheel
        ```
        
        You can install the package locally from the dist:
        
        ```bash
        python3 -m pip ./dist/some_name.whl
        ```
        
        Upload package works also with `make`:
        
        ```bash
        make dist
        make upload
        ```
        
        For local development:
        
        ```bash
        python3 setup.py develop
        ```
        
        ## Contributing to the documentation
        
        The documentation is a collection of [markdown](https://en.wikipedia.org/wiki/Markdown) files in the `docs` folder.  
        After updates of the files, build and check the result with the following commands:
        
        ```bash
        make build-docs
        make serve-docs 
        ```
        
        To update the changes to the official documentation pages run:
        
        ```bash
        make publish-docs
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
