yhttp-dbmanager 5.0.1__tar.gz → 6.0.2__tar.gz

{yhttp_dbmanager-5.0.1/yhttp_dbmanager.egg-info → yhttp_dbmanager-6.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: yhttp-dbmanager
-Version: 5.0.1
+Version: 6.0.2
 Summary: Database manager command line interface and API for yhttp.
 Home-page: http://github.com/yhttp/yhttp-dbmanager
 Author: Vahid Mardani
@@ -22,14 +22,132 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: yhttp<7,>=6.2
+Requires-Dist: yhttp<8,>=7.0.1
 Requires-Dist: psycopg2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # yhttp-dbmanager
 
 A `yhttp` extension to create and remove database(s) using command line and
 API.
 
+
+## Quickstart
+
+### Dependencies
+Install `postgresql` brefore use of this project.
+```bash
+apt install postgresql
+```
+
+### Prepare
+
+Create and grant the `postgresql` role with `createdb` permission to 
+authenticate the current `unix` user within `postgresql` using the peer 
+authentication.
+```bash
+echo "CREATE USER ${USER} WITH CREATEDB" | sudo -u postgres psql
+# Or
+echo "ALTER USER ${USER} CREATEDB" | sudo -u postgres psql
+```
+
+### Usage
+
+Import and install the extension inside the `roolup.py`:
+
+```python
+# foo/version.py
+__version__ = '0.1.'
+```
+
+
+```python
+# foo/rollup.py
+from yhttp.core import Application
+from yhttp.ext import dbmanager
+
+from .version import __version__
+
+
+app = Application(__version__, 'foo')
+
+
+# builtin settings
+app.settings.merge('''
+db:
+  url: postgres://:@/ticketing
+```)
+
+
+# install extensions
+dbmanager.install(app)
+
+
+# http handlers
+from . import handlers
+```
+
+
+```python
+# foo/__init__.py
+from .version import __version__
+from .rollup import app
+```
+
+
+```python
+# setup.py
+import re
+from os.path import join, dirname
+
+from setuptools import setup, find_packages
+
+
+# reading package version (same way the sqlalchemy does)
+with open(join(dirname(__file__), 'foo/version.py')) as v_file:
+    package_version = re.compile('.*__version__ = \'(.*?)\'', re.S).\
+        match(v_file.read()).group(1)
+
+
+dependencies = [
+    'yhttp >= 7.0.1, < 8'
+    'yhttp-dbmanager >= 5.0.1, < 6'
+]
+
+
+setup(
+    name='foo',
+    version=package_version,
+    install_requires=dependencies,
+    packages=find_packages(
+        where='.',
+        exclude=['tests']
+    ),
+    entry_points={
+        'console_scripts': [
+            'foo = foo:app.climain'
+        ]
+    },
+)
+
+```
+
+After installing the extension these command line interfaces will be available
+as as subcommand of your application command line interface:
+```bash
+foo db --help
+```
+
+
 ## Contribution
 
 ### Dependencies

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/README.md

@@ -3,6 +3,114 @@
 A `yhttp` extension to create and remove database(s) using command line and
 API.
 
+
+## Quickstart
+
+### Dependencies
+Install `postgresql` brefore use of this project.
+```bash
+apt install postgresql
+```
+
+### Prepare
+
+Create and grant the `postgresql` role with `createdb` permission to 
+authenticate the current `unix` user within `postgresql` using the peer 
+authentication.
+```bash
+echo "CREATE USER ${USER} WITH CREATEDB" | sudo -u postgres psql
+# Or
+echo "ALTER USER ${USER} CREATEDB" | sudo -u postgres psql
+```
+
+### Usage
+
+Import and install the extension inside the `roolup.py`:
+
+```python
+# foo/version.py
+__version__ = '0.1.'
+```
+
+
+```python
+# foo/rollup.py
+from yhttp.core import Application
+from yhttp.ext import dbmanager
+
+from .version import __version__
+
+
+app = Application(__version__, 'foo')
+
+
+# builtin settings
+app.settings.merge('''
+db:
+  url: postgres://:@/ticketing
+```)
+
+
+# install extensions
+dbmanager.install(app)
+
+
+# http handlers
+from . import handlers
+```
+
+
+```python
+# foo/__init__.py
+from .version import __version__
+from .rollup import app
+```
+
+
+```python
+# setup.py
+import re
+from os.path import join, dirname
+
+from setuptools import setup, find_packages
+
+
+# reading package version (same way the sqlalchemy does)
+with open(join(dirname(__file__), 'foo/version.py')) as v_file:
+    package_version = re.compile('.*__version__ = \'(.*?)\'', re.S).\
+        match(v_file.read()).group(1)
+
+
+dependencies = [
+    'yhttp >= 7.0.1, < 8'
+    'yhttp-dbmanager >= 5.0.1, < 6'
+]
+
+
+setup(
+    name='foo',
+    version=package_version,
+    install_requires=dependencies,
+    packages=find_packages(
+        where='.',
+        exclude=['tests']
+    ),
+    entry_points={
+        'console_scripts': [
+            'foo = foo:app.climain'
+        ]
+    },
+)
+
+```
+
+After installing the extension these command line interfaces will be available
+as as subcommand of your application command line interface:
+```bash
+foo db --help
+```
+
+
 ## Contribution
 
 ### Dependencies

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/setup.py

@@ -18,7 +18,7 @@ with open(
 
 
 dependencies = [
-    'yhttp >= 6.2, < 7',
+    'yhttp >= 7.0.1, < 8',
     'psycopg2',
 ]
 

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/tests/test_cli.py

@@ -15,7 +15,7 @@ class Bar(easycli.SubCommand):
         print('bar')
 
 
-app = Application()
+app = Application('0.1.0', 'foo')
 app.settings.merge('''
 db:
   url: postgres://:@/foo

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/tests/test_install.py

@@ -4,7 +4,7 @@ from yhttp.core import Application
 from yhttp.ext.dbmanager import install
 
 
-app = Application()
+app = Application('0.1.0', 'foo')
 
 
 def test_install():

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/yhttp/ext/dbmanager/__init__.py

@@ -5,4 +5,4 @@ from .dbmanager import PostgresqlManager
 from .uri import DatabaseURI
 
 
-__version__ = '5.0.1'
+__version__ = '6.0.2'

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2}/yhttp/ext/dbmanager/install.py

@@ -13,5 +13,3 @@ def install(app, cliarguments=None):
                 'Please provide db.url configuration entry, for example: '
                 'postgres://:@/dbname'
             )
-
-    return app

{yhttp_dbmanager-5.0.1 → yhttp_dbmanager-6.0.2/yhttp_dbmanager.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: yhttp-dbmanager
-Version: 5.0.1
+Version: 6.0.2
 Summary: Database manager command line interface and API for yhttp.
 Home-page: http://github.com/yhttp/yhttp-dbmanager
 Author: Vahid Mardani
@@ -22,14 +22,132 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: yhttp<7,>=6.2
+Requires-Dist: yhttp<8,>=7.0.1
 Requires-Dist: psycopg2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # yhttp-dbmanager
 
 A `yhttp` extension to create and remove database(s) using command line and
 API.
 
+
+## Quickstart
+
+### Dependencies
+Install `postgresql` brefore use of this project.
+```bash
+apt install postgresql
+```
+
+### Prepare
+
+Create and grant the `postgresql` role with `createdb` permission to 
+authenticate the current `unix` user within `postgresql` using the peer 
+authentication.
+```bash
+echo "CREATE USER ${USER} WITH CREATEDB" | sudo -u postgres psql
+# Or
+echo "ALTER USER ${USER} CREATEDB" | sudo -u postgres psql
+```
+
+### Usage
+
+Import and install the extension inside the `roolup.py`:
+
+```python
+# foo/version.py
+__version__ = '0.1.'
+```
+
+
+```python
+# foo/rollup.py
+from yhttp.core import Application
+from yhttp.ext import dbmanager
+
+from .version import __version__
+
+
+app = Application(__version__, 'foo')
+
+
+# builtin settings
+app.settings.merge('''
+db:
+  url: postgres://:@/ticketing
+```)
+
+
+# install extensions
+dbmanager.install(app)
+
+
+# http handlers
+from . import handlers
+```
+
+
+```python
+# foo/__init__.py
+from .version import __version__
+from .rollup import app
+```
+
+
+```python
+# setup.py
+import re
+from os.path import join, dirname
+
+from setuptools import setup, find_packages
+
+
+# reading package version (same way the sqlalchemy does)
+with open(join(dirname(__file__), 'foo/version.py')) as v_file:
+    package_version = re.compile('.*__version__ = \'(.*?)\'', re.S).\
+        match(v_file.read()).group(1)
+
+
+dependencies = [
+    'yhttp >= 7.0.1, < 8'
+    'yhttp-dbmanager >= 5.0.1, < 6'
+]
+
+
+setup(
+    name='foo',
+    version=package_version,
+    install_requires=dependencies,
+    packages=find_packages(
+        where='.',
+        exclude=['tests']
+    ),
+    entry_points={
+        'console_scripts': [
+            'foo = foo:app.climain'
+        ]
+    },
+)
+
+```
+
+After installing the extension these command line interfaces will be available
+as as subcommand of your application command line interface:
+```bash
+foo db --help
+```
+
+
 ## Contribution
 
 ### Dependencies

yhttp_dbmanager-6.0.2/yhttp_dbmanager.egg-info/requires.txt

@@ -0,0 +1,2 @@
+yhttp<8,>=7.0.1
+psycopg2

yhttp_dbmanager-5.0.1/yhttp_dbmanager.egg-info/requires.txt

@@ -1,2 +0,0 @@
-yhttp<7,>=6.2
-psycopg2