Skip to main content

this is just a template

Project description

template

This is a template generated by farzad in order to be used as a standard in Adler software development. this readme file is written in MarkDown in a github friendly way.

Installation and setup

just use the following code for generating a wheel file.

python setup.py bdist_wheel

and for installing and using the created wheel file locally run the following.

pip install -e .
pip install -e .[dev]

for installing it on another environment use this:

pip install /path/wheel.whl

use pytest to make sure package is working properly. it is a powerfull tool to investigate the modules and everything automatically.

pytest

also twine has a good testing mechanism.

Any doubts about installation and setuptools refere to setuptools or watch this video.

important to know: in the next version the setup.py must send the wheel file to the database!

Python Packaging User Guide

Source distribution

For sending the source code to another distination use:

python setup.py sdist

then check for all the needed files. if they were not their use maifest using:

pip install check-manifest
check-manifest --create
git add MANIFEST.in

then compress it and publish it (internally of course!).

tar tzf dist/template-0.0.1.tar.gz

Importing

import the package name and then call for the functions and objects.

from template import template
template.say_hello()

Test

  • Everything must have a unit test and api test files.
  • Please check everything before you request a code review or merge.
  • The correctness of your code is your responsibility.
  • Check the speed of your code and if possible report the code complexity indexes.
  • use pytest for general syntax check.
  • use tox for testing on different versions of python.
# tox.ini
[tox]
envlist = py36,py37

[testenv]
deps=pytest
commands=pytest
pip install tox
tox

Test and Deploy

Only those packages that are indipendent are going to be deployed others will be imported and recieve an authorization from the guardian sentinel. Deployment will be done using DpckerFile. Our system is linux ubuntu focal forsa, so all the codes must be compatible with this disto of operating system.

Other stuff

you can use pip freeze to extract all the installed packages and their versions.

pip freeze > requirements.txt

Warnings

  • Do not push into master, main, or dev!
  • You only and only push into your own branches!

Farzad Ziaie Nezhad | ZLION

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

sensus-0.0.1.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

sensus-0.0.1-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file sensus-0.0.1.tar.gz.

File metadata

  • Download URL: sensus-0.0.1.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.1.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for sensus-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ef410294c59a4b81f65b9f524bd24c0a2aae7785b255e91fa677a147af80277b
MD5 c59897ad32f4062057fe43653f17c8bc
BLAKE2b-256 18e8909e293812fd206e488aa5c484737448bea03b2af01eaca940fddb940b47

See more details on using hashes here.

File details

Details for the file sensus-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: sensus-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.1.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for sensus-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6fad26d0b85c3fbd09cba7dfe0f45877a006533b081bf3e091564276dc3d507b
MD5 52ece829e0893fa3e3011a8814fa3be0
BLAKE2b-256 7b7f2686073b3a98802206c334a92182d7a8b540b2f483ef7f95aa3ed44c36ad

See more details on using hashes here.

Supported by

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