Welcome to Easy Caesar’s documentation!¶
Easy Caesar¶
an cipher encrypter and decrypter
Features¶
Store values and retain the prior value in memory
… some other functionality
Quick Start¶
from easy_caesar import Example
a = Example()
a.get_value() # 10
Installation¶
Stable Release: pip install easy_caesar
Development Head: pip install git+https://github.com/kyo91/easy_caesar.git
Documentation¶
For full package documentation please visit kyo91.github.io/easy_caesar.
Development¶
See CONTRIBUTING.md for information related to developing the code.
The Four Commands You Need To Know¶
pip install -e .[dev]
This will install your package in editable mode with all the required development dependencies (i.e.
tox
).make build
This will run
tox
which will run all your tests in both Python 3.7 and Python 3.8 as well as linting your code.make clean
This will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.
make docs
This will generate and launch a web browser to view the most up-to-date documentation for your Python package.
Additional Optional Setup Steps:¶
Turn your project into a GitHub repository:
Make sure you have
git
installed, if you don’t, follow these instructionsMake an account on github.com
Go to make a new repository
Recommendations:
It is strongly recommended to make the repository name the same as the Python package name
A lot of the following optional steps are *free if the repository is Public, plus open source is cool*
After a GitHub repo has been created, run the following commands:
git remote add origin git@github.com:kyo91/easy_caesar.git
git push -u origin master
Register easy_caesar with Codecov:
Make an account on codecov.io (Recommended to sign in with GitHub)
Select
kyo91
and click:Add new repository
Copy the token provided, go to your GitHub repository’s settings and under the ``Secrets` tab <https://github.com/kyo91/easy_caesar/settings/secrets>`_, add a secret called
CODECOV_TOKEN
with the token you just copied. Don’t worry, no one will see this token because it will be encrypted.
Generate and add an access token as a secret to the repository for auto documentation generation to work
Go to your GitHub account’s Personal Access Tokens page
Click:
Generate new token
Recommendations:
Name the token: “Auto-Documentation Generation” or similar so you know what it is being used for later
_Select only:
repo:status
,repo_deployment
, andpublic_repo
to limit what this token has access to_
Copy the newly generated token
Go to your GitHub repository’s settings and under the ``Secrets` tab <https://github.com/kyo91/easy_caesar/settings/secrets>`_, add a secret called
ACCESS_TOKEN
with the personal access token you just created. Don’t worry, no one will see this password because it will be encrypted.
Register your project with PyPI:
Make an account on pypi.org
Go to your GitHub repository’s settings and under the ``Secrets` tab <https://github.com/kyo91/easy_caesar/settings/secrets>`_, add a secret called
PYPI_TOKEN
with your password for your PyPI account. Don’t worry, no one will see this password because it will be encrypted.Next time you push to the branch:
stable
, GitHub actions will build and deploy your Python package to PyPI.Recommendation: Prior to pushing to ``stable`` it is recommended to install and run ``bumpversion`` as this will, tag a git commit for release and update the ``setup.py`` version number.
Add branch protections to
master
andstable
To protect from just anyone pushing to
master
orstable
(the branches with more tests and deploy configurations)Go to your GitHub repository’s settings and under the ``Branches` tab <https://github.com/kyo91/easy_caesar/settings/branches>`_, click
Add rule
and select the settings you believe best.Recommendations:
Require pull request reviews before merging
Require status checks to pass before merging (Recommended: lint and test)
Suggested Git Branch Strategy¶
master
is for the most up-to-date development, very rarely should you directly commit to this branch. GitHub Actions will run on every push and on a CRON to this branch but still recommended to commit to your development branches and make pull requests to master.stable
is for releases only. When you want to release your project on PyPI, simply make a PR frommaster
tostable
, this template will handle the rest as long as you have added your PyPI information described in the above Optional Steps section.Your day-to-day work should exist on branches separate from
master
. Even if it is just yourself working on the repository, make a PR from your working branch tomaster
so that you can ensure your commits don’t break the development head. GitHub Actions will run on every push to any branch or any pull request from any branch to any other branch.It is recommended to use “Squash and Merge” commits when committing PR’s. It makes each set of changes to
master
atomic and as a side effect naturally encourages small well defined PR’s.GitHub’s UI is bad for rebasing
master
ontostable
, as it simply adds the commits to the other branch instead of properly rebasing from what I can tell. You should always rebase locally on the CLI until they fix it.
**Free software: MIT license**