Metadata-Version: 2.1
Name: dvc-cc
Version: 0.8.23
Summary: This connector is used to combine the work of CC (www.curious-containers.cc) and DVC (Open-source Version Control System for Machine Learning Projects).
Home-page: https://github.com/mastaer/dvc-cc.git
License: AGPL-3.0
Author: Jonas Annuscheit
Author-email: annusch@htw-berlin.de
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: cc-faice (>=8.0,<9.0)
Requires-Dist: dvc (>=0,<1)
Requires-Dist: keyring (>=19.0,<20.0)
Requires-Dist: matplotlib (>=3.1,<4.0)
Requires-Dist: nbconvert (>=5.5,<6.0)
Requires-Dist: numpy (>=1.16,<2.0)
Requires-Dist: pandas (>=0,<1)
Requires-Dist: paramiko (>=2.4,<3.0)
Requires-Dist: pyrsistent (>=0.15.2,<0.16.0)
Requires-Dist: python-gitlab (>=1.8,<2.0)
Requires-Dist: pyyaml (>=5.1,<6.0)
Requires-Dist: seaborn (>=0,<1)
Project-URL: Repository, https://github.com/mastaer/dvc-cc.git
Description-Content-Type: text/markdown

![The DVC-CC-Logo](../dvc_cc_logo.png)


- TODO: SOME DESCRIPTION
- TODO: GIF of how to use DVC-CC basic commands

## Installation of DVC-CC

DVC-CC is written in python so you can easily install DVC-CC by using pip. We recommend that you install DVC-CC in an [anaconda](https://www.anaconda.com/distribution/) environment.
You can create, and activate an environment with the following lines:

```bash
conda create --name dvc_cc python pip
conda activate dvc_cc
```

### Installation with pip
The following script will install the client on your computer:

```bash
pip install --upgrade dvc-cc
```

### Installation from source

If you want to install the latest version from source you can install it with [poetry](https://poetry.eustace.io/).

```bash
git clone https://github.com/deep-projects/dvc-cc.git
cd dvc-cc/dvc-cc
poetry build
pip install dvc_cc-?????.whl # replace ????? with the current version that you build in the previous step.
```

## Get started
Install DVC-CC and take a look at [this tutorial](dvc-cc/tutorial/Get_Started.md).

### Tutorials
- [Working with jupyter notebooks](tutorial/_working_with_jupyter_notebook.md)
- [working with sshfs](tutorial/_working_with_sshfs.md)
- <del>[An old tutorial](tutorial/SimpleStart.md)</del>

## Structure of this repository


## Acknowledgements
The DVC-CC software is developed at CBMI (HTW Berlin - University of Applied Sciences). The work is supported by the
German Federal Ministry of Education and Research (project deep.TEACHING, grant number 01IS17056 and project
deep.HEALTH, grant number 13FH770IX6).

