Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pechouc/dbs_api

API allowing to download destination-based mappings of multinational companies sales, based on https://github.com/pechouc/destination-based-sales.
https://github.com/pechouc/dbs_api

Last synced: 15 days ago
JSON representation

API allowing to download destination-based mappings of multinational companies sales, based on https://github.com/pechouc/destination-based-sales.

Awesome Lists containing this project

README

        

# Data analysis
- Document here the project: dbs_api
- 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 dbs_api in gitlab.com/{group}.
If your project is not set please add it:

- Create a new project on `gitlab.com/{group}/dbs_api`
- Then populate it:

```bash
$ ## e.g. if group is "{group}" and project_name is "dbs_api"
$ git remote add origin [email protected]:{group}/dbs_api.git
$ git push -u origin master
$ git push -u origin --tags
```

Functionnal test with a script:
```bash
$ cd /tmp
$ dbs_api-run
```
# Install
Go to `gitlab.com/{group}/dbs_api` 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}/dbs_api
$ cd dbs_api
$ pip install -r requirements.txt
$ make clean install test # install and test
```
Functionnal test with a script:
```bash
$ cd /tmp
$ dbs_api-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.