<div align="center">
<img src="https://github.com/shopyo/pythoncms/raw/main/assets/logo.png" width="200"/>
<br><br>
[](https://www.firsttimersonly.com/)
🇲🇺
</div>
# Welcome to pythoncms
## Try
In virtual env
```
pip install pythoncms
pythoncms start mysite
cd mysite
shopyo initialise
flask --debug run
```
If .env file not created, create .env file with content
```.env
ACTIVE_FRONT_THEME = 'editorial'
ACTIVE_BACK_THEME = 'sneat'
APP_NAME = 'Demo'
ACTIVE_ICONSET = 'boxicons'
SITE_TITLE = 'Site title'
SITE_DESCRIPTION = 'Site title'
```
## Local dev
Install package
! Important: Please create and activate a virtual environment.
```
python -m pip install -e .
```
Then initialise
```
cd pythoncms
shopyo initialise
flask --debug run
```
for migrating
```
flask db migrate
flask db upgrade
```
run
```
flask --debug run
```
dashboard
login with `admin@domain.com` | `pass`
```
http://127.0.0.1:5000/dashboard/
```
## Theme
Themes are located at '/static/themes/'
Each front theme must have
```
index.html
contact.html
page.html
```
Each back theme must have
```
base.html
login.html
register.html
unconfirmed.html
```
- info.json
```json
{
"author": "ARJ",
"version": "1.0.20000000000003"
}
```
## Info json
```
{
"display_string": "Admin",
"type": "show", // hidden if hide
"icons":{
"fa": "fas fa-user-lock", // set according to ACTIVE_ICONSET
"boxicons": "", // set according to ACTIVE_ICONSET
"file": "icon.svg" // if present, will be used and searched for
// in module/static. Make sure to shopyo collecstatic in production
},
"url_prefix": "/appadmin",
"menu": {
"list users":"/", // url-prefix will be concatenated with it for sub menus.
"add user": "/add",
"roles":"/roles"
},
"menu-type": "show-menu", // or no-menu. Expects menu key if show-menu.
"module_name": "appadmin",
"author": {
"name":"Abdur-Rahmaan Janhangeer",
"website":"https://www.pythonkitchen.com/about-me/",
"mail":"arj.python@gmail.com"
}
}
```
## Changelog
1.2.0
- Tiny MCE configured
- start command
Raw data
{
"_id": null,
"home_page": null,
"name": "pythoncms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cms",
"author": "Abdur-Rahmaan Janhangeer",
"author_email": "arj.python@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/24/1a0e05cb11de388703186240e320caac295c613eac454cb8dbee54cc93fe/pythoncms-1.3.3.tar.gz",
"platform": null,
"description": "\n<div align=\"center\">\n\n\n\n<img src=\"https://github.com/shopyo/pythoncms/raw/main/assets/logo.png\" width=\"200\"/>\n\n<br><br>\n\n[](https://www.firsttimersonly.com/)\n\n\ud83c\uddf2\ud83c\uddfa\n\n</div>\n\n\n\n# Welcome to pythoncms\n\n## Try\n\n\n\nIn virtual env\n\n```\npip install pythoncms\npythoncms start mysite\ncd mysite\nshopyo initialise\nflask --debug run\n```\n\nIf .env file not created, create .env file with content\n\n```.env\nACTIVE_FRONT_THEME = 'editorial'\nACTIVE_BACK_THEME = 'sneat'\nAPP_NAME = 'Demo'\nACTIVE_ICONSET = 'boxicons'\nSITE_TITLE = 'Site title'\nSITE_DESCRIPTION = 'Site title'\n```\n\n## Local dev\n\nInstall package\n\n! Important: Please create and activate a virtual environment.\n\n```\npython -m pip install -e .\n```\nThen initialise\n\n```\ncd pythoncms\nshopyo initialise\nflask --debug run\n```\n\nfor migrating\n\n```\nflask db migrate\nflask db upgrade\n```\n\nrun\n\n```\nflask --debug run\n```\n\ndashboard\n\nlogin with `admin@domain.com` | `pass`\n```\nhttp://127.0.0.1:5000/dashboard/\n```\n\n## Theme\n\nThemes are located at '/static/themes/'\n\nEach front theme must have\n\n```\nindex.html\ncontact.html\npage.html\n```\n\nEach back theme must have\n\n```\nbase.html\nlogin.html\nregister.html\nunconfirmed.html\n```\n\n- info.json\n\n```json\n{\n\t\"author\": \"ARJ\",\n\t\"version\": \"1.0.20000000000003\"\n}\n```\n\n## Info json\n\n```\n{\n\t\"display_string\": \"Admin\",\n\t\"type\": \"show\", // hidden if hide\n\t\"icons\":{\n\t\t\"fa\": \"fas fa-user-lock\", // set according to ACTIVE_ICONSET\n\t\t\"boxicons\": \"\", // set according to ACTIVE_ICONSET\n\t\t\"file\": \"icon.svg\" // if present, will be used and searched for\n\t\t\t\t\t\t // in module/static. Make sure to shopyo collecstatic in production\n\t},\n\t\"url_prefix\": \"/appadmin\",\n\t\"menu\": {\n\t\t\"list users\":\"/\", // url-prefix will be concatenated with it for sub menus.\n\t\t\"add user\": \"/add\",\n\t\t\"roles\":\"/roles\"\n\t},\n\t\"menu-type\": \"show-menu\", // or no-menu. Expects menu key if show-menu.\n\t\"module_name\": \"appadmin\",\n\t\"author\": {\n\t\t\"name\":\"Abdur-Rahmaan Janhangeer\",\n\t\t\"website\":\"https://www.pythonkitchen.com/about-me/\",\n\t\t\"mail\":\"arj.python@gmail.com\"\n\t\t}\n}\n```\n## Changelog\n\n1.2.0\n\n- Tiny MCE configured\n- start command\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.3.3",
"project_urls": {
"Bug Reports": "https://github.com/shopyo/pythoncms/issues",
"Source": "https://github.com/shopyo/pythoncms"
},
"split_keywords": [
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79e7212d090ec4168db193328202f61b3703e7768616d0336aaae481d2e163be",
"md5": "ca3b6d3d8c2dea40c7fbfa7ccc55024f",
"sha256": "7b34dc3939e54e0e7dbfbbc52be153bcf609675efc0ee3b98032dcbc24b592d7"
},
"downloads": -1,
"filename": "pythoncms-1.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca3b6d3d8c2dea40c7fbfa7ccc55024f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10175963,
"upload_time": "2024-04-16T10:54:00",
"upload_time_iso_8601": "2024-04-16T10:54:00.372931Z",
"url": "https://files.pythonhosted.org/packages/79/e7/212d090ec4168db193328202f61b3703e7768616d0336aaae481d2e163be/pythoncms-1.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "70241a0e05cb11de388703186240e320caac295c613eac454cb8dbee54cc93fe",
"md5": "2c669566106b37106dd90bb5c0c30558",
"sha256": "15ff3f90f777165b174e45d74083e3fce663643d6a086cc3354c60b0c17dd510"
},
"downloads": -1,
"filename": "pythoncms-1.3.3.tar.gz",
"has_sig": false,
"md5_digest": "2c669566106b37106dd90bb5c0c30558",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10046261,
"upload_time": "2024-04-16T10:54:03",
"upload_time_iso_8601": "2024-04-16T10:54:03.715967Z",
"url": "https://files.pythonhosted.org/packages/70/24/1a0e05cb11de388703186240e320caac295c613eac454cb8dbee54cc93fe/pythoncms-1.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 10:54:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shopyo",
"github_project": "pythoncms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "shopyo",
"specs": [
[
"==",
"4.8.6"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"1.4.46"
]
]
},
{
"name": "python-dotenv",
"specs": []
}
],
"tox": true,
"lcname": "pythoncms"
}
JSON
