pythoncms


Namepythoncms JSON
Version 1.4.1 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-10-13 19:33:30
maintainerNone
docs_urlNone
authorAbdur-Rahmaan Janhangeer
requires_python>=3.7
licenseNone
keywords cms
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
<div align="center">



<img src="https://github.com/shopyo/pythoncms/raw/main/assets/logo.png" width="200"/>

<br><br>

[![First Timers Only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://www.firsttimersonly.com/)

🇲🇺

</div>



# Welcome to pythoncms

## Try

![](https://github.com/shopyo/pythoncms/raw/main/assets/term.gif)

In virtual env

```
pip install pythoncms
pythoncms start mysite
cd mysite
shopyo initialise
flask shopyo-seed
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/af/2e0248e52c1e20dea4993c5871a1ce5791e52ac475efae16f60c77ed523c/pythoncms-1.4.1.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[![First Timers Only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](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![](https://github.com/shopyo/pythoncms/raw/main/assets/term.gif)\n\nIn virtual env\n\n```\npip install pythoncms\npythoncms start mysite\ncd mysite\nshopyo initialise\nflask shopyo-seed\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.4.1",
    "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": "c7ddb986aba77172fd141fa264dd0f1e1695cfe09f78f78ff9ee64cb093ca8a9",
                "md5": "c86feadbe03aab72acf7aba702257ccb",
                "sha256": "cdf5862b025639a24552d032a0f071a277a7c63c0d60bd0fb12efb4a04427c88"
            },
            "downloads": -1,
            "filename": "pythoncms-1.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c86feadbe03aab72acf7aba702257ccb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10114179,
            "upload_time": "2024-10-13T19:33:28",
            "upload_time_iso_8601": "2024-10-13T19:33:28.311907Z",
            "url": "https://files.pythonhosted.org/packages/c7/dd/b986aba77172fd141fa264dd0f1e1695cfe09f78f78ff9ee64cb093ca8a9/pythoncms-1.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70af2e0248e52c1e20dea4993c5871a1ce5791e52ac475efae16f60c77ed523c",
                "md5": "6fba33e16b8e7e94e3191b3880855571",
                "sha256": "516b9bd94ac4d8380d1116eebe03cae50d6bacbe7817e49ca15a70946ff98c21"
            },
            "downloads": -1,
            "filename": "pythoncms-1.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6fba33e16b8e7e94e3191b3880855571",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 10011085,
            "upload_time": "2024-10-13T19:33:30",
            "upload_time_iso_8601": "2024-10-13T19:33:30.619521Z",
            "url": "https://files.pythonhosted.org/packages/70/af/2e0248e52c1e20dea4993c5871a1ce5791e52ac475efae16f60c77ed523c/pythoncms-1.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-13 19:33:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "shopyo",
    "github_project": "pythoncms",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "pythoncms"
}
        
Elapsed time: 0.33464s