frankyang0529 / pycon.tw

PyCon TW official website

PyCon TW

This repository serves the website of PyCon TW, Python Conference Taiwan. This project is open source and the license can be found in LICENSE.

Getting Started

Requirements

• Git 1.8+
• Python 3.6.x
• Yarn 1.0+
• Node.js 8.0+

Set up a Virtual Environment

Database - Docker (Optional)

Write database password in .env:

POSTGRES_PASSWORD=somepassword

Define .env location in docker-compose-dev.yml under the corresponding database service:

services:
  db:
    image: postgres:11-alpine
    env_file:
      - .env

Create and start the database for development:

docker-compose -f docker-compose-dev.yml up

Python - Built-in venv

Create your virtual environment:

python3 -m venv venv

And enable it:

. venv/bin/activate

Python - virtualenvwrapper

You need to specify your python path when creating the virtual environment:

mkvirtualenv --python=$(which python3) pycontw2016

Node.js - nvm

Switch to version specified in .nvmrc:

nvm use

Install Dependencies

Use pip to install Python depedencies:

pip install -r requirements.txt

Use Yarn to install Node dependencies:

yarn install --dev

Set up Local Environment Variables and Database

Settings are stored in environment variables via django-environ. The quickest way to start is to copy local.sample.env into local.env:

cp src/pycontw2016/settings/local.sample.env src/pycontw2016/settings/local.env

Then edit the SECRET_KEY line in local.env, replacing {{ secret_key }} into any Django Secret Key value. An example:

SECRET_KEY=twvg)o_=u&@6^*cbi9nfswwh=(&hd$bhxh9iq&h-kn-pff0&&3

If you’re using a database for the first time, create a database named pycontw2016 owned by the database user specified in the env file:

Enter pycontw_db_1 container

docker exec -it pycontw_db_1 psql -U postgres

# Replace "postgres" with your specified role.
CREATE DATABASE pycontw2016 with owner = postgres;

After that, just run the migration.

Get Ready for Development

cd into the src directory:

cd src

DB Connection

Default is sqlite3, you can change to connect postgres. Copy local.sample.env and change its parameters to your personal setting.

cp pycontw2016/settings/local.sample.env pycontw2016/settings/local.env

The format of local.env will be used by django-environ so you may refer to https://github.com/joke2k/django-environ for more details.

And migrate the database:

python manage.py migrate

Create Super User

python manage.py createsuperuser

Compile localized translation

python manage.py compilemessages

Now you’re all set!

Run the Development Server

python manage.py runserver

Run Tests

Tests are managed with pytest-django. You have two options to run tests, either with the local environment, or in an isolated one via Tox.

Testing in the Local Environment

Run the following command inside src:

pytest

To run tests with coverage report:

pytest --cov=.

Testing with Tox

Run the following inside the top-level directory (the one with tox.ini):

tox

How to Contribute

Follow the GitHub Flow, please DO NOT push the commits into master directly. Always create branch by the feature you want to update. You are encouraged to submit a pull request for reviewing before merging things into master.

We strongly recommend you configure your editor to match our coding styles. You can do this manually, or use an EditorConfig plugin if your editor supports it. An .editorconfig file has already been attached to the repository.

Deployment

For site administrators, please refer to contrib/DEPLOY.md.