sqlemon 0.7.0

Scripts

Installing SQLemon puts two scripts into your virtualenv’s bin/ directory:

• start_cloud_proxy: Run the Google Cloud SQL proxy using an authentication token you downloaded when making a service account. See below for details about where that authentication token should be stored.

• start_mysql_client: Run MySQL client on your machine, connecting either to the production server (through the proxy) or to a local test database.

Files

We assume you have your project’s source on your system at PROJECT_ROOT/, where PROJECT_ROOT is probably something like ~/src/<whatever>/. The file layout should look something like this:

├── PROJECT_ROOT/
│    ├── PROJECT_NAME/  <-- important
│    │   ├── __init__.py
│    │   ├── alembic.ini
│    │   ├── alembic/
│    │   ├── lib/
│    │   ├── models.py
│    │   └── main.py
│    ├── README.md
│    ├── appengine_config.py
|    ├── secrets.py             <-- important, GITIGNORE THIS FILE!
│    └── app.yaml               <-- important

SQLemon needs app.yaml to have the following environment variables:

env_variables:
    INSTANCE_CONNECTION_NAME: ...
    CLOUD_SQL_USER: <Cloud SQL user name>

When running in production mode on App Engine, SQLemon will get the root user’s SQL password from secrets.py, which should look like this:

CLOUD_SQL_PASSWORD = <Cloud SQL user password>

MAKE SURE YOU ADD secrets.py TO GITIGNORE SO YOU DON’T PUT SECRETS IN VERSION CONTROL!

You must also have a directory at ~/.PROJECT_NAME with a couple of files described below. Here are the required layouts of the required files:

• ~/.PROJECT_NAME/config.yaml

  ---
  cloud:
      PASSWORD: <Cloud SQL user password>
  local:
      USER: <Local database user name, e.g. "root">
      PASSWORD: <Local database root password, e.g. "">
      HOST: "localhost"
      PORT: 3306

• ~/.PROJECT_NAME/auth-token.json: This is your proxy’s user account auth token.

How to release

$ python setup.py register -r pypi(test)
$ python setup.py sdist upload -r pypi(test)