fundamentals


Namefundamentals JSON
Version 1.1.1 PyPI version JSON
home_pagehttps://github.com/thespacedoctor/fundamentals
SummarySome project setup tools including logging, settings and database connections
upload_time2017-01-20 12:53:37
maintainerNone
docs_urlNone
authorDavid Young
requires_pythonNone
licenseMIT
keywords logging database
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
Coveralis test coverage No Coveralis.
            fundamentals
=========================

*Some project setup tools including logging, settings and database connections.*

Here's a summary of what's included in the python package:

.. include:: /docs/classes_and_function.rst


Documentation
=============

Documentation for fundamentals is hosted by `Read the Docs <http://fundamentals.readthedocs.org/en/stable/>`__ (last `stable version <http://fundamentals.readthedocs.org/en/stable/>`__ and `latest version <http://fundamentals.readthedocs.org/en/latest/>`__).

Installation
============

The easiest way to install fundamentals us to use ``pip``:

.. code:: bash

    pip install fundamentals

Or you can clone the `github repo <https://github.com/thespacedoctor/fundamentals>`__ and install from a local version of the code:

.. code:: bash

    git clone git@github.com:thespacedoctor/fundamentals.git
    cd fundamentals
    python setup.py install

To upgrade to the latest version of fundamentals use the command:

.. code:: bash

    pip install fundamentals --upgrade


Development
-----------

If you want to tinker with the code, then install in development mode.
This means you can modify the code from your cloned repo:

.. code:: bash

    git clone git@github.com:thespacedoctor/fundamentals.git
    cd fundamentals
    python setup.py develop

`Pull requests <https://github.com/thespacedoctor/fundamentals/pulls>`__
are welcomed!


Issues
------

Please report any issues
`here <https://github.com/thespacedoctor/fundamentals/issues>`__.

License
=======

Copyright (c) 2016 David Young

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
            

Raw data

            {
    "maintainer": null, 
    "docs_url": null, 
    "requires_python": null, 
    "maintainer_email": null, 
    "cheesecake_code_kwalitee_id": null, 
    "coveralis": false, 
    "keywords": "logging,database", 
    "upload_time": "2017-01-20 12:53:37", 
    "author": "David Young", 
    "home_page": "https://github.com/thespacedoctor/fundamentals", 
    "github_user": "thespacedoctor", 
    "download_url": "https://pypi.python.org/packages/12/76/45b3b5ea8fa19e88a4d28d6e2dbccd45a653c9a1769305c7c594181ec635/fundamentals-1.1.1.tar.gz", 
    "platform": "UNKNOWN", 
    "version": "1.1.1", 
    "cheesecake_documentation_id": null, 
    "description": "fundamentals\n=========================\n\n*Some project setup tools including logging, settings and database connections.*\n\nHere's a summary of what's included in the python package:\n\n.. include:: /docs/classes_and_function.rst\n\n\nDocumentation\n=============\n\nDocumentation for fundamentals is hosted by `Read the Docs <http://fundamentals.readthedocs.org/en/stable/>`__ (last `stable version <http://fundamentals.readthedocs.org/en/stable/>`__ and `latest version <http://fundamentals.readthedocs.org/en/latest/>`__).\n\nInstallation\n============\n\nThe easiest way to install fundamentals us to use ``pip``:\n\n.. code:: bash\n\n    pip install fundamentals\n\nOr you can clone the `github repo <https://github.com/thespacedoctor/fundamentals>`__ and install from a local version of the code:\n\n.. code:: bash\n\n    git clone git@github.com:thespacedoctor/fundamentals.git\n    cd fundamentals\n    python setup.py install\n\nTo upgrade to the latest version of fundamentals use the command:\n\n.. code:: bash\n\n    pip install fundamentals --upgrade\n\n\nDevelopment\n-----------\n\nIf you want to tinker with the code, then install in development mode.\nThis means you can modify the code from your cloned repo:\n\n.. code:: bash\n\n    git clone git@github.com:thespacedoctor/fundamentals.git\n    cd fundamentals\n    python setup.py develop\n\n`Pull requests <https://github.com/thespacedoctor/fundamentals/pulls>`__\nare welcomed!\n\n\nIssues\n------\n\nPlease report any issues\n`here <https://github.com/thespacedoctor/fundamentals/issues>`__.\n\nLicense\n=======\n\nCopyright (c) 2016 David Young\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.", 
    "lcname": "fundamentals", 
    "bugtrack_url": null, 
    "github": true, 
    "name": "fundamentals", 
    "license": "MIT", 
    "travis_ci": false, 
    "github_project": "fundamentals", 
    "summary": "Some project setup tools including logging, settings and database connections", 
    "split_keywords": [
        "logging", 
        "database"
    ], 
    "author_email": "davidrobertyoung@gmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-01-20T12:53:37", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/12/76/45b3b5ea8fa19e88a4d28d6e2dbccd45a653c9a1769305c7c594181ec635/fundamentals-1.1.1.tar.gz", 
            "md5_digest": "752a38b3101d75125c6cb2431dc0ec6c", 
            "downloads": 0, 
            "filename": "fundamentals-1.1.1.tar.gz", 
            "packagetype": "sdist", 
            "path": "12/76/45b3b5ea8fa19e88a4d28d6e2dbccd45a653c9a1769305c7c594181ec635/fundamentals-1.1.1.tar.gz", 
            "size": 36512
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}