# Giant Events
A re-usable package which can be used in any project that requires a generic `Events` 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-events
You should then add `"events", "easy_thumbnails" and "filer"` to the `INSTALLED_APPS` in `base.py`.
## Configuration
This application exposes the following settings:
- `EVENT_ADMIN_LIST_DISPLAY` is the field list for the admin index. This must be a list
- `EVENT_ADMIN_FIELDSETS` allows the user to define the admin fieldset. This must be a list of two-tuples
- `EVENT_ADMIN_READONLY_FIELDS` allows the user to configure readonly fields in the admin. This must be a list
- `EVENT_ADMIN_SEARCH_FIELDS` allows the user to configure search fields in the admin. This must be a list
- `EVENT_ADMIN_FILTER_FIELDS` allows the user to configure filter fields in the admin. This must be a list
- `PAGINATE_EVENTS_BY` allows user to determine how many events to paginate by on the index page. Applies to time directed queryset. This must be an int
- `DEFAULT_TIME_DIRECTION` chose from one of the following options - PAST, FUTURE & ANYTIME
By default the app will use the templates that are defined inside the app directory itself. However if you wish to override which template is used you will need to create a directory in the projects template directory
The structure should look something like this:
```
templates/
events/
index.html
detail.html
```
## URLs
Add the following to `core.urls` for general functionality:
path("events/", include("events.urls"), name="events"),
If you want to customize the urls to include a different path and/or templates, first you must import `from events import views as event_views` in `core.urls` and then you could add the following:
path("events/", event_views.EventIndex.as_view(template_name="event/index.html"), name="event-index"),
path("events/<slug:slug>/", event_views.EventDetail.as_view(template_name="event/detail.html"), name="event-detail"),
## 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-events",
"name": "giant-events",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.6.2",
"maintainer_email": null,
"keywords": "events, app",
"author": "Will-Hoey",
"author_email": "will.hoey@giantmade.com",
"download_url": "https://files.pythonhosted.org/packages/21/2f/4c5cf5a6b5036a7c0379057ea450cd9c24ff927ebf7b06e707e75a4bc286/giant_events-0.3.0.2.tar.gz",
"platform": null,
"description": "# Giant Events\n\nA re-usable package which can be used in any project that requires a generic `Events` 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-events\n\nYou should then add `\"events\", \"easy_thumbnails\" and \"filer\"` to the `INSTALLED_APPS` in `base.py`. \n\n\n## Configuration\n\nThis application exposes the following settings:\n\n- `EVENT_ADMIN_LIST_DISPLAY` is the field list for the admin index. This must be a list\n- `EVENT_ADMIN_FIELDSETS` allows the user to define the admin fieldset. This must be a list of two-tuples\n- `EVENT_ADMIN_READONLY_FIELDS` allows the user to configure readonly fields in the admin. This must be a list\n- `EVENT_ADMIN_SEARCH_FIELDS` allows the user to configure search fields in the admin. This must be a list\n- `EVENT_ADMIN_FILTER_FIELDS` allows the user to configure filter fields in the admin. This must be a list\n- `PAGINATE_EVENTS_BY` allows user to determine how many events to paginate by on the index page. Applies to time directed queryset. This must be an int\n- `DEFAULT_TIME_DIRECTION` chose from one of the following options - PAST, FUTURE & ANYTIME\n\nBy default the app will use the templates that are defined inside the app directory itself. However if you wish to override which template is used you will need to create a directory in the projects template directory\nThe structure should look something like this:\n\n```\ntemplates/\n events/\n index.html\n detail.html\n```\n\n\n\n## URLs\n\nAdd the following to `core.urls` for general functionality:\n\n path(\"events/\", include(\"events.urls\"), name=\"events\"),\n\nIf you want to customize the urls to include a different path and/or templates, first you must import `from events import views as event_views` in `core.urls` and then you could add the following:\n\n path(\"events/\", event_views.EventIndex.as_view(template_name=\"event/index.html\"), name=\"event-index\"),\n path(\"events/<slug:slug>/\", event_views.EventDetail.as_view(template_name=\"event/detail.html\"), name=\"event-detail\"),\n \n ## Preparing for release\n \n 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`.\n 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/.\n \n ## Publishing\n \n 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.\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 an Events app to a project",
"version": "0.3.0.2",
"project_urls": {
"Homepage": "https://github.com/giantmade/giant-events",
"Repository": "https://github.com/giantmade/giant-events"
},
"split_keywords": [
"events",
" app"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f4fc92ead4fbbd6f4888b9d6487d9f30219d206ac5b729b7c81d11b7f188bf5",
"md5": "4e85ab1b7a8759e6a98b087a4b2b0daf",
"sha256": "728373eaf56b38df1ffdce14431a636f4ddb45455b0e91bf6e126ea12d8704c1"
},
"downloads": -1,
"filename": "giant_events-0.3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e85ab1b7a8759e6a98b087a4b2b0daf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.6.2",
"size": 16046,
"upload_time": "2024-04-10T13:44:33",
"upload_time_iso_8601": "2024-04-10T13:44:33.369138Z",
"url": "https://files.pythonhosted.org/packages/5f/4f/c92ead4fbbd6f4888b9d6487d9f30219d206ac5b729b7c81d11b7f188bf5/giant_events-0.3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "212f4c5cf5a6b5036a7c0379057ea450cd9c24ff927ebf7b06e707e75a4bc286",
"md5": "5aebd1ca5b4c062e4c39c1569dfdddb2",
"sha256": "13441a8bf4b48057350b144b396c82291818f777b9d695c7bcaea77ed9fa738b"
},
"downloads": -1,
"filename": "giant_events-0.3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5aebd1ca5b4c062e4c39c1569dfdddb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.6.2",
"size": 10571,
"upload_time": "2024-04-10T13:44:36",
"upload_time_iso_8601": "2024-04-10T13:44:36.438608Z",
"url": "https://files.pythonhosted.org/packages/21/2f/4c5cf5a6b5036a7c0379057ea450cd9c24ff927ebf7b06e707e75a4bc286/giant_events-0.3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 13:44:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giantmade",
"github_project": "giant-events",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "giant-events"
}
JSON
