https://github.com/takp/poc-base-sample
https://github.com/takp/poc-base-sample
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/takp/poc-base-sample
- Owner: takp
- Created: 2018-09-07T04:33:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-07T07:57:26.000Z (over 6 years ago)
- Last Synced: 2024-12-27T09:27:56.888Z (5 months ago)
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# poc-base-sample
Sample task implementation for Podder.ai pipeline framework.
How to implement a task using poc-base repository.
## How to run sample code
### Create virtual environment
Create Python virtual environment. Please check [Creation of virtual environments](https://docs.python.org/3/library/venv.html)
### For Mac os, Linux user
```bash
# clone poc-base
$ git clone [email protected]:podder-ai/poc-base-sample.git
$ cd poc-base-sample
# configure environment variables
$ cp .env.sample .env
# enable python3
$ python3 -m venv env
$ source env/bin/activate
# install required libraries
$ pip install -r requirements.txt
# run sample code
$ python main.py
```
### For Windows user with PowerShell
If using Powershell, the activate script is subject to the execution policies on the system. By default on Windows 7, the system's excution policy is set to `Restricted`, meaning no scripts as virtualenv activation script are allowed to be executed.
In order to use the script, you can relax your system's execution policy to `Unrestricted`, meaning all scripts on the system can be executed. As an administrator run:
```
C:\>Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force -Verbose
```
```bash
C:\>python -m venv C:\path\to\myenv
# Windows cmd.exe
C:\> C:\path\to\myenv\Scripts\activate.bat
# PowerShell PS
C:\> C:\path\to\myenv\Scripts\Activate.ps1
```
### Via Docker
For detail Dockerfile check [here](./Dockerfile)
```bash
# build docker image with python enviroment
$ docker build -t poc-sample .
# run code
$ docker run -ti poc-sample python main.py
```
## Source code directory
```
$ tree . -L 2
.
├── README.md
├── app
│ ├── __init__.py
│ ├── __pycache__
│ └── task.py # main task implementation
├── data
│ └── tmp # where to put your data
├── framework # framework code base
│ ├── __init__.py
│ ├── __pycache__
│ ├── base_task.py
│ ├── config.py
│ ├── context.py
│ ├── file.py
│ └── logger.py
├── main.py
├── requirements.txt # add required packages here
├── .env.sample # sample of environment variables
├── .env # where to add your environment variables
```
## How to implement the new task
Please check the implementation guideline here. [PoC base guideline](https://github.com/podder-ai/poc-base)