Skip to content

Commit

Permalink
Removed unused stuff (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
Gramet authored Apr 22, 2024
1 parent 5a5cc05 commit 3a08bf2
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 95 deletions.
9 changes: 3 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ jobs:

steps:
- uses: actions/checkout@v3
- uses: VisiumCH/check-python-style@main
- uses: psf/black@stable
with:
python-version: "3.10"

- name: Test with pytest
run: |
pytest
options: "--check --verbose"
src: "./src"
63 changes: 0 additions & 63 deletions .github/workflows/cml.yml

This file was deleted.

20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
[![CI](https://github.com/VisiumCH/crowd_programming/actions/workflows/ci.yml/badge.svg)](https://github.com/VisiumCH/crowd_programming/actions/workflows/ci.yml)

[![CML](https://github.com/VisiumCH/crowd_programming/actions/workflows/cml.yml/badge.svg)](https://github.com/VisiumCH/crowd_programming/actions/workflows/cml.yml)

# README

## Set up your development environment and run the DVC pipeline
Expand All @@ -15,23 +13,6 @@ The python environment is managed with `pipenv`. You can set up your environment
- Run `gcloud auth` to authenticate to your GCP account.
- Finally run `dvc repro` to execute the complete pipeline! You can also execute a single step and its dependencies with `dvc repro <step_name>`.


## Set up CML

For the continuous delivery pipeline to work, you will need to do the following:

- `PERSONAL_ACCESS_TOKEN`: a github personal access token (PAT) that has write access on your repository. This is necessary to let `cml` merge code in the repo.
- `GOOGLE_APPLICATION_CREDENTIALS_DATA`: a json key authenticating a google service account that has the role `Compute Admin` and `Storage Admin`.
- Set up your github repository to accept auto-merge. This will allow CML to commit the `dvc.lock` after running your pipeline.
- Finally you need to create a bucket and configure the `.dvc/config` file of the project to make it the remote bucket of the project. You can do this with the following command: `dvc remote add -d myremote gs://mybucket`. You can also do this manually by editing the `.dvc/config` file.


## Guidelines to follow to make the most out of DVC

Please refer to this [Notion page](https://www.notion.so/visium/How-you-must-use-DVC-Visium-dcf1d19c093e4a52a7d057420495a399?pvs=4).



## Some tips about pipenv

**Deploy in production**
Expand All @@ -41,4 +22,3 @@ Note that when deploying your code in production, you should not install the dev
**Git with pipenv**

Make sure to commit the `Pipfile.lock` in `git`. It will make your code more reproducible because other developers could install the exact same python packages as you used.

6 changes: 0 additions & 6 deletions src/test/test_sample.py

This file was deleted.

0 comments on commit 3a08bf2

Please sign in to comment.