Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Lol

Project description

https://img.shields.io/badge/code%20style-black-000000.svg https://codecov.io/gh/nazime/pyalmostnothing/branch/master/graph/badge.svg

pyalmostnothing

pyalmostnothing is python project that does (almost) nothing, it only show how to structure python projects, test project, docs…..

features

  • testing with pytest and tox
  • installable with setup.py
  • documentation with sphinx
  • readthedocs
  • coverage (codecov)
  • code quality
  • how to test coverage?
  • CI with travis
    • testing with tox
    • deploy to Pypi

Features

install

pip install <project_name>

Package

The following code work

import pyalmostnothing

print(pyalmostnothing.inc(5))
# 6
print(pyalmostnothing.add(3, 6))
# 9

CLI

Can use it in the console

pycalculate inc 5
# 6
pycalculate add 5 5
# 10

Logs

Each operation is logged

cat ~/.pycalculate/logs.txt
inc 5
add 5 5

Workflow

create similar project

Cookie cutter

Test the project

tox –showconfig tox -vvvvvv # 3 tox 3 pytest tox -r # recreate

git clone <project url>
pip install tox
tox

Retest the project

tox

If it doesnt work

# -r recreate
tox -r

Test only one env

tox -l  # list all envs
tox -e <env>  # Ex: tox -e py37 for python3.7

Interact with the project

First must run tox and then chose un environment

tox -l  # list aff environments
source .tox/<env>/bin/activate  # Ex: source .tox/py37/bin/activate
deactivate  # to Exit env

Integration with pycharm

First run tox to have the environment, install the plugin PyVenv Manage and select an environment.

  • create venv
  • map key (list des racourcies
  • run tests
  • Editor -> inspections?
  • src mark directory as src
  • change testrunner to pytest

Automatic deploy yo pypi

First deploy it manually (to create a scope in Pypi for security reason)

rm -rf dist  # remove folder if exist
python setup.py sdist bdist_wheel
# Check if you can upload the package
twine check dist/*
twine upload dist/*

Make sure you have ruby install to get travis

sudo apt-get install ruby-dev
sudo gem install travis

Project details


Download files

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

Files for pyalmostnothing, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size pyalmostnothing-0.1.2-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pyalmostnothing-0.1.2.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page