💾 Archived View for gemini.hyperlinkyourheart.com › gemicandocs › pages › installing-gemican.gmi captured on 2024-08-18 at 17:26:11. Gemini links have been rewritten to link to archived content

View Raw

More Information

⬅️ Previous capture (2021-11-30)

-=-=-=-=-=-=-

Installing Gemican

Gemican currently runs best on 3.6+; earlier versions of Python are not supported.

You can install Gemican via several different methods. The simplest is via Pip[1]:

python -m pip install gemican

Or, if you plan on using Markdown:

python -m pip install "gemican[markdown]"

(Keep in mind that some operating systems will require you to prefix the above command with `sudo` in order to install Gemican system-wide.)

While the above is the simplest method, the recommended approach is to create a virtual environment for Gemican via virtualenv[2] before installing Gemican. Assuming you have virtualenv installed, you can then open a new terminal session and create a new virtual environment for Gemican:

virtualenv ~/virtualenvs/gemican
cd ~/virtualenvs/gemican
source bin/activate

Once the virtual environment has been created and activated, Gemican can be installed via `python -m pip install gemican` as noted above. Alternatively, if you have the project source, you can install Gemican using the distutils method:

cd path-to-Gemican-source
python setup.py install

If you have Git installed and prefer to install the latest bleeding-edge version of Gemican rather than a stable release, use the following command:

python -m pip install -e "git+https://github.com/getgemican/gemican.git#egg=gemican"

Once Gemican is installed, you can run `gemican --help` to see basic usage options. For more detail, refer to the Publish[3] section.

Optional packages

If you plan on using Markdown[4] as a markup format, you can install Gemican with Markdown support:

python -m pip install "gemican[markdown]"

Dependencies

When Gemican is installed, the following dependent Python packages should be automatically installed without any action on your part:

Upgrading

If you installed a stable Gemican release via Pip[17] and wish to upgrade to the latest stable release, you can do so by adding `--upgrade`:

python -m pip install --upgrade gemican

If you installed Gemican via distutils or the bleeding-edge method, simply perform the same step to install the most recent version.

Kickstart your site

Once Gemican has been installed, you can create a skeleton project via the `gemican-quickstart` command, which begins by asking some questions about your site:

gemican-quickstart

If run inside an activated virtual environment, `gemican-quickstart` will look for an associated project path inside `$VIRTUAL_ENV/.project`. If that file exists and contains a valid directory path, the new Gemican project will be saved at that location. Otherwise, the default is the current working directory. To set the new project path on initial invocation, use: `gemican-quickstart --path /your/desired/directory`

Once you finish answering all the questions, your project will consist of the following hierarchy (except for *pages* — shown in parentheses below — which you can optionally add yourself if you plan to create non-chronological content):

yourproject/
├── content
│   └── (pages)
├── output
├── tasks.py
├── Makefile
├── gemicanconf.py       # Main settings file
└── publishconf.py       # Settings to use when ready to publish

The next step is to begin to adding content to the *content* folder that has been created for you.

1: https://pip.pypa.io/

2: https://virtualenv.pypa.io/en/latest/

3: {filename}/pages/publish.md

4: https://pypi.org/project/Markdown/

5: https://pypi.org/project/feedgenerator/

6: https://pypi.org/project/Jinja2/

7: https://pypi.org/project/pytz/

8: https://pypi.org/project/blinker/

9: https://pypi.org/project/Unidecode/

10: https://pypi.org/project/MarkupSafe/

11: https://pypi.org/project/python-dateutil/

12: https://github.com/willmcgugan/rich

13: https://twistedmatrix.com/trac/

14: https://pypi.org/project/pyOpenSSL/

15: https://pypi.org/project/service-identity/

16: https://github.com/ahupp/python-magic

17: https://pip.pypa.io/

↩ Index