A content management system (CMS) written in Python that allows you to create, edit, and publish web content
# Arch Linux - required packages
$ sudo pacman -Syu
$ sudo pacman -S python-pyqt5 python-pyqt5-webengine python-pip sqlite openssh upx
$ python -V && pip --version
$ pip install python-i18n pandas country_converter black pyinstaller
# Ubuntu - required packages
$ sudo apt update
$ sudo apt install python3-pyqt5 python3-pyqt5.qtwebengine python3-pip sqlite3 openssh-client upx
$ python3 -V && pip3 --version
$ pip3 install python-i18n pandas country_converter black pyinstaller
# Clone repository
$ git clone git@github.com:ncklinux/LocalPythonCMS.git
$ cd LocalPythonCMS
$ git checkout -b YOUR_BRANCH_NAME
# Virtual environment (recommended). To manage libraries with pip, the following commands are used to create and activate the required virtual environment.
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install python-i18n pandas country_converter black pyinstaller requests PyQt5 PyQtWebEngine PyYAML
# Launch
$ python main.py
# Build for production
$ wget https://github.com/konstantinstadler/country_converter/blob/master/country_converter/country_data.tsv
# Another way it's to find the file and use the relative path to country_data.tsv e.g. --add-data '../.local/lib/python3.YOUR_VERSION/site-packages/country_converter/country_data.tsv' or, just copy country_data.tsv in LocalPythonCMS directory
# find / -type f -name "country_data.tsv" 2>&1 | grep -v 'Permission denied'
$ python -m PyInstaller --noconsole --onefile --windowed --exclude-module tkinter --add-data 'country_data.tsv:country_converter' main.py
# There are also some other options, like fbs (based on PyInstaller) or FlatpakHaving a local CMS that publishes only the content you choose, on a remote server (securely via SSH and Ed25519 elliptic curve signature key pair, as the book Practical Cryptography with Go suggests that those keys are more secure and efficient) is great for many reasons, for example maintainability! Being able to update the CMS without hassle and system and network administration knowledge (just like updating your web browser) makes it fun 😉
Most importantly, you own your data, locally! Keeping your data stored on your local computer 💻 (including backups) makes it safe 🔒 by default! Simply because, there is no reason to store sensitive data on a remote server and leave them there, without that data even needing (in most times) to be called and used on the websites.
John Johnson says “First, solve the problem. Then, write the code.”
This project uses python-i18n for translations, an out-of-the-box library for designing and developing software, so it can be adapted for users of different cultures and languages. The files are located in the locales directory in YAML format. JSON format is also supported, to be used it must be specified explicitly i18n.set('file_format', 'json')
Start the SQLite program by typing sqlite3 at the Terminal, followed by the name of the file that holds the database.
$ sqlite3 assets/sqlite/localpythoncms.sqlite
# SQLite CLI
sqlite> .tables
sqlite> select * from users;
This project follows the PEP8 style, which provides guidelines and best practices for writing Python code, and Black for formatting, that makes code review faster by producing the smallest diffs possible (it's already available for most editors and IDEs VSCode, ST4, PyCharm and also via CLI e.g. black {source_file_or_directory}, to list all options use black --help).
If you use PyCharm but for whatever reason you don't want to use the BlackConnect plugin and therefore blackd, follow the screenshots below to set up black as an external tool with a file watcher in order to run it on save. Use which black to identify the location of the executable and add it in the "Program" input field.
GNU General Public License v3.0 - See the LICENSE file in this project for details.
This project is distributed FREE & WITHOUT ANY WARRANTY. Report any bugs or suggestions as an issue.
Please read the contribution guidelines.
This repository follows the Conventional Commits specification, the commit message should never exceed 100 characters and must be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
I will keep and maintain this project as open source forever! Watch it, give it a ⭐ and follow me on GitHub and Twitter
Icons from Google Material Symbols
