Cnchi

Graphical Installer for Antergos Linux

License GitHub issues Github commits Release date

You are viewing the 0.16.x branch (stable).

Current Status

Development Stage	Branch	Version	Code Status
Cnchi Stable	0.16.x		Frozen
Cnchi Development	0.17.x		Development
Cnchi Next (UI agnostic)	master	master	Development

Usage:

sudo -E cnchi.py

Optional parameters:

Command	Description
`-a` , `--a11y`	Set accessibility feature on by default
`-c` , `--cache`	Use pre-downloaded xz packages when possible
`-d` , `--debug`	Sets Cnchi log level to 'debug'
`-e` , `--environment`	Sets the Desktop Environment that will be installed, see desktop_info.py for options
`-f` , `--force`	Runs cnchi even if it detects that another instance is running
`-n` , `--no-check`	Makes checks optional in check screen
`-p` , `--packagelist`	Install the packages referenced by a local xml instead of the defaults, see #617 for proper usage
`-t` , `--no-tryit`	Disables first screen's 'try it' option
`-v` , `--verbose`	Show logging messages to stdout
`-V` , `--version`	Show Cnchi version and quit
`-z` , `--hidden`	Show options in development (for developers only, do not use this!)

To create logs to help debug problems:

sudo -E cnchi.py -dv

Reporting bugs:

Please report any issues with Cnchi in the issue tracker. Provide all log files along with a detailed description:

/var/log/cnchi/cnchi.log
/var/log/cnchi/cnchi-alpm.log (if it exists)
/var/log/cnchi/postinstall.log (if it exists)
/var/log/cnchi/pacman.log (if it exists)

Translations

We manage our translations via Transifex

Dependencies

gtk3
python (python3)
python-cairo
python-chardet
python-dbus
python-feedparser
python-gobject
python-idna
python-mako
python-requests
geoip (python-geoip2, python-maxminddb, geoip2-database)
pyparted (parted, dosfstools, mtools, ntfs-3g, ntfsprogs)
pyalpm (alpm)
upower
gocryptfs
iso-codes
clutter, clutter-gtk, clutter-gst
gsteamer1.0
python-libnacl

Unit tests

python-mock

Fonts needed by the keyboard widget

ttf-aboriginal-sans
ttf-indic-otf
ttf-khmer
ttf-lohit-fonts
ttf-myanmar3
ttf-thaana-fonts
ttf-tlwg

Building Cnchi

PKGBUILD

Development

Getting started

You will need to install all dependencies.

Fork Cnchi
Do your changes (use 0.16.x branch as base!)

Then, you can use the run script to test Cnchi. As this is a Installer, you will need to use a Virtual Machine or an additional harddisk to test it.

How to easy prepare a sane testing environment:

Download Antergos ISO
Create a new VM in Virtualbox, add the live iso and a virtual harddisk (two harddisks if you want to cache the downloaded packages)
Run the VM
Cnchi will open, close it.
Remove Cnchi ISO version: sudo rm -rf /usr/share/cnchi
Install git: sudo pacman -S git

Install - Install your Cnchi version from your own repository:

cd /home/antergos
git clone https://github.com/<username>/cnchi
cd cnchi
sudo ln -s /home/antergos/cnchi /usr/share/cnchi

Create a screenshot of the VM (so you don't have to redo all this each time you want to test your changes).
Run Cnchi and start testing!

If your tests are OK, you can then create your PR and push it here (against development branch, which now it's 0.16.x)

Development Tips

When creating a Pull Request (PR), please check that you follow the PEP8 style guide (you have a stylized presentation at pep8.org). You can use pycodestyle (former pep8) or pylint.org or whatever you prefer to check your python3 files.

Spaces are the preferred indentation method.

Documented classes

To start tinkering, we would recommend to check all open #issues and find one you find you will be able to start with (choose something that seems easy to do), so you feel familiar with cnchi's structure. You can find info about it at readthedocs

Antergos / Cnchi

readme