giant-people


Namegiant-people JSON
Version 0.4 PyPI version JSON
download
home_pagehttps://github.com/giantmade/giant-people
SummaryA small reusable package that adds a People app to a project
upload_time2021-03-23 16:43:23
maintainer
docs_urlNone
authorWill-Hoey
requires_python>=3.6,<4.0
licenseMIT
keywords people app
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Giant People

A re-usable package which can be used in any project that requires a generic `People` app. 

This will include the basic formatting and functionality such as model creation via the admin.

## Installation

To install with the package manager, run:

    $ poetry add giant-people

You should then add `"people", "easy_thumbnails" and "filer"` to the `INSTALLED_APPS` in your settings file. 
The detail pages in this app use plugins which are not contained within this app. It is recommended that you include a set of plugins in your project, or use the `giant-plugins` app.

In order to run `django-admin` commands you will need to set the `DJANGO_SETTINGS_MODULE` by running

    $ export DJANGO_SETTINGS_MODULE=settings

## Preparing for release
 
In order to prep the package for a new release on TestPyPi and PyPi there is one key thing that you need to do. You need to update the version number in the `pyproject.toml`.
This is so that the package can be published without running into version number conflicts. The version numbering must also follow the Semantic Version rules which can be found here https://semver.org/.

## Publishing

Publishing a package with poetry is incredibly easy. Once you have checked that the version number has been updated (not the same as a previous version) then you only need to run two commands.

  $ `poetry build` 

will package the project up for you into a way that can be published.

  $ `poetry publish`

will publish the package to PyPi. You will need to enter the username and password for the account which can be found in the company password manager

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/giantmade/giant-people",
    "name": "giant-people",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6,<4.0",
    "maintainer_email": "",
    "keywords": "people,app",
    "author": "Will-Hoey",
    "author_email": "will.hoey@giantmade.com",
    "download_url": "https://files.pythonhosted.org/packages/b9/e8/0584776ab4842b01952ff01281bffc196b46434e1ec88daec93c773185fc/giant-people-0.4.tar.gz",
    "platform": "",
    "description": "# Giant People\n\nA re-usable package which can be used in any project that requires a generic `People` app. \n\nThis will include the basic formatting and functionality such as model creation via the admin.\n\n## Installation\n\nTo install with the package manager, run:\n\n    $ poetry add giant-people\n\nYou should then add `\"people\", \"easy_thumbnails\" and \"filer\"` to the `INSTALLED_APPS` in your settings file. \nThe detail pages in this app use plugins which are not contained within this app. It is recommended that you include a set of plugins in your project, or use the `giant-plugins` app.\n\nIn order to run `django-admin` commands you will need to set the `DJANGO_SETTINGS_MODULE` by running\n\n    $ export DJANGO_SETTINGS_MODULE=settings\n\n## Preparing for release\n \nIn order to prep the package for a new release on TestPyPi and PyPi there is one key thing that you need to do. You need to update the version number in the `pyproject.toml`.\nThis is so that the package can be published without running into version number conflicts. The version numbering must also follow the Semantic Version rules which can be found here https://semver.org/.\n\n## Publishing\n\nPublishing a package with poetry is incredibly easy. Once you have checked that the version number has been updated (not the same as a previous version) then you only need to run two commands.\n\n  $ `poetry build` \n\nwill package the project up for you into a way that can be published.\n\n  $ `poetry publish`\n\nwill publish the package to PyPi. You will need to enter the username and password for the account which can be found in the company password manager\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A small reusable package that adds a People app to a project",
    "version": "0.4",
    "split_keywords": [
        "people",
        "app"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5eec4d8ca4ee9e2a011c385e7a583339",
                "sha256": "8d1f5e8322050bd3d0b6d395b358ffdbb7ee827e68626decd8b5fd961ec0aaa1"
            },
            "downloads": -1,
            "filename": "giant_people-0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5eec4d8ca4ee9e2a011c385e7a583339",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6,<4.0",
            "size": 23229,
            "upload_time": "2021-03-23T16:43:25",
            "upload_time_iso_8601": "2021-03-23T16:43:25.178292Z",
            "url": "https://files.pythonhosted.org/packages/64/e8/ef3c34260a5bfb37780761045961fa9d7ef4c72bf1b869af400001ed16f4/giant_people-0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "15ebf045167cee1020dfb4382c0ac67a",
                "sha256": "0e817c5e39a30e903de4b5ae9b9a0d2491c20d2eb2f5aa7c45ee95d75b58fdac"
            },
            "downloads": -1,
            "filename": "giant-people-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "15ebf045167cee1020dfb4382c0ac67a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6,<4.0",
            "size": 10927,
            "upload_time": "2021-03-23T16:43:23",
            "upload_time_iso_8601": "2021-03-23T16:43:23.808546Z",
            "url": "https://files.pythonhosted.org/packages/b9/e8/0584776ab4842b01952ff01281bffc196b46434e1ec88daec93c773185fc/giant-people-0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-03-23 16:43:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "giantmade",
    "error": "Could not fetch GitHub repository",
    "lcname": "giant-people"
}
        
Elapsed time: 0.26710s