https://github.com/pechouc/catchafish_app

https://github.com/pechouc/catchafish_app

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/pechouc/catchafish_app
• Owner: pechouc
• Created: 2020-07-01T08:36:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-02T07:37:59.000Z (over 4 years ago)
• Last Synced: 2024-11-19T19:07:07.681Z (2 months ago)
• Language: Python
• Size: 488 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Data analysis

- Document here the project: catchafish_app

- Description: Project Description

- Data Source:

- Type of analysis:

Please document the project the better you can.

# Stratup the project

The initial setup.

Create virtualenv and install the project:

```bash

  $ sudo apt-get install virtualenv python-pip python-dev

  $ deactivate; virtualenv ~/venv ; source ~/venv/bin/activate ;\

    pip install pip -U; pip install -r requirements.txt

```

Unittest test:

```bash

  $ make clean install test

```

Check for catchafish_app in gitlab.com/{group}.

If your project is not set please add it:

- Create a new project on `gitlab.com/{group}/catchafish_app`

- Then populate it:

```bash

  $ ##   e.g. if group is "{group}" and project_name is "catchafish_app"

  $ git remote add origin [email protected]:{group}/catchafish_app.git

  $ git push -u origin master

  $ git push -u origin --tags

```

Functionnal test with a script:

```bash

  $ cd /tmp

  $ catchafish_app-run

```

# Install

Go to `gitlab.com/{group}/catchafish_app` to see the project, manage issues,

setup you ssh public key, ...

Create a python3 virtualenv and activate it:

```bash

  $ sudo apt-get install virtualenv python-pip python-dev

  $ deactivate; virtualenv -ppython3 ~/venv ; source ~/venv/bin/activate

```

Clone the project and install it:

```bash

  $ git clone gitlab.com/{group}/catchafish_app

  $ cd catchafish_app

  $ pip install -r requirements.txt

  $ make clean install test                # install and test

```

Functionnal test with a script:

```bash

  $ cd /tmp

  $ catchafish_app-run

``` 

# Continus integration

## Github 

Every push of `master` branch will execute `.github/workflows/pythonpackages.yml` docker jobs.

## Gitlab

Every push of `master` branch will execute `.gitlab-ci.yml` docker jobs.