CouchApp: Standalone CouchDB Application Development Made Simple
================================================================
This is a forked version of the original python2-only CouchApp application provided in `couchapp <https://github.com/couchapp/couchapp>`_.
This repository is meant to provide a CouchApp application compatible with python3, for that, the following changes have been done:
* Removal of all Windows related code (it only supports Linux and MacOS now)
* Replacement of ``restkit`` by ``requests`` python library (its only third-party dependency!)
* Removed all the codebase that is not required for ``couchapp push`` command.
* Tested in CouchDB 1.6.1 with plain http requests.
In short, this App can be used to construct and push your CouchDB application, starting from a properly organized directory structure with javascript/erlang/html/css scripts and files.
Installation
------------
Couchapp requires Python2 (tested with Python 2.7) for versions in the ``1.2.x`` cycle.
Starting in ``1.3.x`` cycle, it will require Python3 (tested with Python 3.8).
Couchapp is most easily installed using the latest versions of the standard
python packaging tools, ``setuptools`` and ``pip``.
They may be installed like so::
$ curl -O https://bootstrap.pypa.io/3.5/get-pip.py
$ sudo python get-pip.py
Installing couchapp is then simply a matter of::
$ pip install couchapp
or this way if you cannot access the root (or due to SIP on macOS),
then find the executable at ``~/.local/bin``.
For more info about ``--user``, please checkout ``pip help install``::
$ pip install --user couchapp
To install/upgrade a development version of couchapp::
$ pip install -e git+http://github.com/amaltaro/couchapp.git#egg=Couchapp
Note: Some installations need to use *sudo* command before each command
line.
Note: On debian system don't forget to install python-dev.
Releases
--------
For **python2**, the recommended version is: ``1.2.10``.
For **Python3**, the recommended version is: ``1.3.2``. Note that this version no longer supports python2.
Last but not least, releases from ``1.2.2`` to ``1.2.7`` are not fully functional and should not be used.
Pushing your CouchApp
---------------------
Once you have installed the CMSCouchapp library, you can install your CouchDB application with a command like:
``couchapp push -p /data/TestCouchApp -c http://localhost:5984/test_database_name``
or if you want to simply visualize how the design document would look like, in a dry-run mode, you could run:
``couchapp push -p /data/TestCouchApp -c http://localhost:5984/test_database_name --export``
which would dump the design document into stdout.
Raw data
{
"_id": null,
"home_page": "http://github.com/amaltaro/couchapp",
"name": "CMSCouchapp",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "couchdb couchapp",
"author": "Alan Malta",
"author_email": "alan.malta@cern.ch",
"download_url": "https://files.pythonhosted.org/packages/58/7f/d5d3edca138679ade3ea8e3cf8842a9b10d2db9bab6a9d94c581b3c2cd88/CMSCouchapp-1.3.4.tar.gz",
"platform": "unix",
"description": "CouchApp: Standalone CouchDB Application Development Made Simple\n================================================================\nThis is a forked version of the original python2-only CouchApp application provided in `couchapp <https://github.com/couchapp/couchapp>`_.\nThis repository is meant to provide a CouchApp application compatible with python3, for that, the following changes have been done:\n\n* Removal of all Windows related code (it only supports Linux and MacOS now)\n* Replacement of ``restkit`` by ``requests`` python library (its only third-party dependency!)\n* Removed all the codebase that is not required for ``couchapp push`` command.\n* Tested in CouchDB 1.6.1 with plain http requests.\n\nIn short, this App can be used to construct and push your CouchDB application, starting from a properly organized directory structure with javascript/erlang/html/css scripts and files.\n\n\nInstallation\n------------\nCouchapp requires Python2 (tested with Python 2.7) for versions in the ``1.2.x`` cycle.\nStarting in ``1.3.x`` cycle, it will require Python3 (tested with Python 3.8).\n\nCouchapp is most easily installed using the latest versions of the standard\npython packaging tools, ``setuptools`` and ``pip``.\nThey may be installed like so::\n\n $ curl -O https://bootstrap.pypa.io/3.5/get-pip.py\n $ sudo python get-pip.py\n\nInstalling couchapp is then simply a matter of::\n\n $ pip install couchapp\n\nor this way if you cannot access the root (or due to SIP on macOS),\nthen find the executable at ``~/.local/bin``.\nFor more info about ``--user``, please checkout ``pip help install``::\n\n $ pip install --user couchapp\n\nTo install/upgrade a development version of couchapp::\n\n $ pip install -e git+http://github.com/amaltaro/couchapp.git#egg=Couchapp\n\nNote: Some installations need to use *sudo* command before each command\nline.\n\nNote: On debian system don't forget to install python-dev.\n\nReleases\n--------\nFor **python2**, the recommended version is: ``1.2.10``.\n\nFor **Python3**, the recommended version is: ``1.3.2``. Note that this version no longer supports python2.\n\nLast but not least, releases from ``1.2.2`` to ``1.2.7`` are not fully functional and should not be used.\n\nPushing your CouchApp\n---------------------\nOnce you have installed the CMSCouchapp library, you can install your CouchDB application with a command like:\n\n``couchapp push -p /data/TestCouchApp -c http://localhost:5984/test_database_name``\n\n\nor if you want to simply visualize how the design document would look like, in a dry-run mode, you could run:\n\n``couchapp push -p /data/TestCouchApp -c http://localhost:5984/test_database_name --export``\n\nwhich would dump the design document into stdout.\n\n",
"bugtrack_url": null,
"license": "Apache License 2",
"summary": "Standalone CouchDB Application Development Made Simple.",
"version": "1.3.4",
"split_keywords": [
"couchdb",
"couchapp"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e387b0a4a23f8d0824fa8f643a730c97",
"sha256": "d57b4589a8dc04f2d4c0dba0f55787a8754225a30a4890d70f91d25a0a9a4cea"
},
"downloads": -1,
"filename": "CMSCouchapp-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e387b0a4a23f8d0824fa8f643a730c97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37478,
"upload_time": "2021-06-04T11:47:56",
"upload_time_iso_8601": "2021-06-04T11:47:56.873074Z",
"url": "https://files.pythonhosted.org/packages/21/d0/30d0ce111e6b63876d7891adf26a0ee6e5f28671b97c2d0e8a9662db79a3/CMSCouchapp-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "80395787b3b9175ef5e4a83ba7a11d0a",
"sha256": "ccdb83574de2b1f644bf9ba1868efe7dbed786f37cd56ce845aeef7110fbdb86"
},
"downloads": -1,
"filename": "CMSCouchapp-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "80395787b3b9175ef5e4a83ba7a11d0a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27527,
"upload_time": "2021-06-04T11:47:58",
"upload_time_iso_8601": "2021-06-04T11:47:58.360110Z",
"url": "https://files.pythonhosted.org/packages/58/7f/d5d3edca138679ade3ea8e3cf8842a9b10d2db9bab6a9d94c581b3c2cd88/CMSCouchapp-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-06-04 11:47:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "amaltaro",
"github_project": "couchapp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cmscouchapp"
}
JSON
