Skip to content

Commit

Permalink
fix(setup): add simple packaging information
Browse files Browse the repository at this point in the history
* starting version at 0.0.1
* converted README from MD to RST with pandoc
* url points to github
* classifiers added, mostly copy-pasted from letsencrypt official client
  (with the addition of python 3 support and exclusion of curses)

suggestion to fix #20
  • Loading branch information
Pavel Savchenko committed Dec 4, 2015
1 parent 976a338 commit feb0be7
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 1 deletion.
87 changes: 87 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
simp\_le
========

|Build Status|

Simple `Let’s Encrypt`_ client.

.. code:: shell
simp_le -f fullchain.pem -f key.pem \
-d example.com -d www.example.com --default_root /var/www/html \
-d other.com:/var/www/other_html
For more info see ``simp_le --help``.

Manifest
--------

1. `UNIX philosophy`_: Do one thing and do it well!

2. ``simp_le --valid_min ${seconds?} -f cert.pem`` implies that
``cert.pem`` is valid for at at least ``valid_min``. Register new
ACME CA account if necessary. Issue new certificate if no previous
key/certificate/chain found. Renew only if necessary.

3. (Sophisticated) “manager” for
``${webroot?}/.well-known/acme-challenge`` only. No challenges other
than ``http-01``. Existing web-server must be running already.

4. No magical webserver auto-configuration.

5. Owner of ``${webroot?}/.well-known/acme-challenge`` must be able to
run the script, without privilege escalation (``sudo``, ``root``,
etc.).

6. ``crontab`` friendly: fully automatable - no prompts, etc.

7. No configuration files. CLI flags as the sole interface! Users
should write their own wrapper scripts or use shell aliases if
necessary.

8. Support multiple domains with multiple roots. Always create single
SAN certificate per ``simp_le`` run.

9. Flexible storage capabilities. Built-in
``simp_le -f fullchain.pem -f key.pem``,
``simp_le -f chain.pem -f cert.pem -f key.pem``, etc. Extensions
through ``simp_le -f external_pem.sh``.

10. Do not allow specifying output file paths. Users should symlink if
necessary!

11. No need to allow specifying an arbitrary command when renewal has
happened, just check the exit code:

- ``0`` if certificate data was created or updated;
- ``1`` if renewal not necessary;
- ``2`` in case of errors.

12. ``--server`` (support multiple CAs).

13. Support for revocation.

Installation
------------

.. code:: shell
sudo ./bootstrap.sh
./venv.sh
. venv/bin/activate
Help
----

Have a look into ``./examples/`` and
https://github.com/kuba/simp\_le/wiki/Examples.

If you’re having problems you can chat with us on `IRC (#simp\_le at
Freenode)`_

.. _Let’s Encrypt: https://letsencrypt.org
.. _UNIX philosophy: https://en.wikipedia.org/wiki/Unix_philosophy
.. _IRC (#simp\_le at Freenode): http://webchat.freenode.net?randomnick=1&channels=%23simp_le&prompt=1

.. |Build Status| image:: https://travis-ci.org/kuba/simp_le.svg?branch=master
:target: https://travis-ci.org/kuba/simp_le
28 changes: 27 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,17 @@
'pylint',
]

version = '0.0.1' # set static for now

setuptools.setup(
name='simp_le',
version=version,
author='Jakub Warmuz',
author_email='jakub@warmuz.org',
description="A Simple Let's Encrypt client",
long_description=open('README.rst').read(),
license='GPLv3',

url='https://github.com/kuba/simp_le',
py_modules=['simp_le'],
install_requires=install_requires,
extras_require={
Expand All @@ -41,4 +46,25 @@
'simp_le = simp_le:main',
],
},
classifiers=[
'Development Status :: 3 - Alpha',
'Environment :: Console',
'Intended Audience :: System Administrators',
'License :: OSI Approved :: Apache Software License',
'Operating System :: POSIX :: Linux',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Topic :: Internet :: WWW/HTTP',
'Topic :: Security',
'Topic :: System :: Installation/Setup',
'Topic :: System :: Networking',
'Topic :: System :: Systems Administration',
'Topic :: Utilities',
],
)

0 comments on commit feb0be7

Please sign in to comment.