From 170e244949f17bd7b3bd938eb0b8d5b1d76036d5 Mon Sep 17 00:00:00 2001 From: "Diogenes S. Jesus" Date: Sun, 12 Nov 2017 22:23:03 +0100 Subject: [PATCH] typo in README, add gitignore back, fix testbundle README * typo in README, add gitignore back, fix testbundle README --- .gitignore | 6 ++++++ README.md | 4 ++-- tests/testbundle/README.md | 34 +++++++++++++--------------------- 3 files changed, 21 insertions(+), 23 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cb5844e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +**/*.pyc +**/*.pyo +build +dist +*.egg-info +.idea \ No newline at end of file diff --git a/README.md b/README.md index 57fdede..bcd5112 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,11 @@ For example, defining: * `commands\commanda.py` - maps to `!commanda` * `commands\level1\commandb.py` - maps to `!level1-commandb` * `commands\level1\level2a\commandc.py` - maps to `!level1-level2a-commandb` - * `commands\level1\level2b\leveln\commandz.py` - maps to `!level1-level2b-lebeln-commandz` + * `commands\level1\level2b\leveln\commandz.py` - maps to `!level1-level2b-leveln-commandz` ``` - + | |-- |-- __init__.py diff --git a/tests/testbundle/README.md b/tests/testbundle/README.md index 7f6da09..399d44d 100644 --- a/tests/testbundle/README.md +++ b/tests/testbundle/README.md @@ -3,36 +3,28 @@ testbundle # Overview -This is a dummy cog bundle used to test pycog3 python module +This is a dummy cog bundle used to test pycog3 python module. -# Installing - -Create a virtual env and: - -```bash -pip3 install --upgrade . -``` - # Configuring -There is one dynamic configuration file which should be set in the environmental variables: - -```bash -export dyn_config_var1 - -``` +There is one dynamic configuration variable `dyn_config_var1` which should be set in the environmental variables: # Executing +Should be executed after `pycog3` is installed. +If running outside cog's environment, at the root of the project `/`, do: + ```bash -/usb/bin/cog-command +$ export PYTHONPATH=tests/testbundle +$ export COG_BUNDLE="testbundle" +$ export COG_COMMAND="commanda" +$ export dyn_config_var1="foo" +$ cog-command +COG_TEMPLATE: template +JSON +"0a" ``` -# Building - -To build the Docker image, simply run: - $ make docker -Requires Python 3.6.x, pip, make, and Docker.