Skip to main content

Elementary Mathematics.

Project description

.. image::

.. image::

.. image::

.. image::

.. image::

.. image::!--None.svg?style=social

.. contents::

Welcome to ``elementary_math`` Documentation
``elementary_math`` is a project to demonstrate: how to setup environment and toolsets for a python library project on github, includes these **powerful components**:

- virtual environment setup (one command install everything)
- file (one click **install**/**uninstall**)
- auto Google stylize your code
- fancy sphinx document (one click **build**/**view**/**deploy**)
- unittest suits with pytest
- code coverage test with coverall
- multi python version test with tox
- integration with
- integration with
- auto deploy to `AWS S3 <>`_
- publish to `PyPI <>`_

Quick Links
- `GitHub Homepage <>`_
- `Online Documentation <>`_
- `PyPI download <>`_
- `Install <install_>`_
- `Issue submit and feature request <>`_
- `API reference and source code <>`_

1. Clone the repo.
2. Navigate to ``elementary_math-project/start-a-project``, edit ```` and run it.
3. A ``<repo-name>`` directory will be created, you can use this as your github repo directory.
4. Take a look at ``Makefile``, all magic happens here!

AWS Command Line (Optional)
Use `AWS S3 <>`_ to host your doc site is a good idea!

We need `awscli <>`_ to automate the deployment.

1. Install `awscli <>`_, just ``pip install awscli``.
2. `Configure your API token <>`_, just ``aws configure`` and follow the instruction.

Config PyPI (Optional)
If you want to publish your package to `PyPI <>`_ or `new PyPI <>`_, you need a pypi account and `Configure your credential <>`_.

1. Create a ``${HOME}/.pypirc`` file.
2. put these contents::

index-servers =


CI (Continues Integration) (Optional)
1. `Test with travis-ci <>`_, basically you just need to:
- sign in using GitHub account.
- toggle on your repo.
2. `Code Coverage Test with codecov <>`_.

For Windows
Because Windows doesn't have ``shell script`` and ``make`` command, so we have to install some third-party software to make it works.

**Install Git Bash as shell emulator**

1. `Download and install git <>`_.
2. Now you can use ``C:\Program Files\Git\git-bash.exe`` like the terminal in MacOS/Linux.

**Install MinGW**

1. `Download and install <>`_, use the installer to install ``MinGW Base``.
2. Find ``C:\MinGW\bin\mingw32-make.exe``, copy and paste and rename as ``C:\MinGW\bin\make.exe``.
3. Add ``C:\MinGW\bin`` to $PATH (environment variable).

Now you can use ``make <target>`` in ``git-bash.exe`` now.

For MacOS
You have to make sure:

- `HomeBrew <>`_ is installed.

There's two way of using virtualenv in MacOS:

1. Use generic `virtualenv <>`_.
2. Use `pyenv <>`_ + `pyenv-virtualenv <>`_.

I prefer ``pyenv`` + ``pyenv-virtualenv``, because it allows you:

1. use tox to test against multiple python version locally before using cloud CI (continues integration).
2. will not mess up your global python environment.
3. the ``Makefile`` will do the ``pyenv`` + ``pyenv-virtualenv`` setup for you, just make sure that you have `HomeBrew <>`_ installed.

.. _install:


``elementary_math`` is released on PyPI, so all you need is:

.. code-block:: console

$ pip install elementary_math

To upgrade to latest version:

.. code-block:: console

$ pip install --upgrade elementary_math

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elementary_math-0.0.8.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

elementary_math-0.0.8-py2-none-any.whl (12.6 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page