Package: easy-caesar
Easy Caesaran cipher encrypter and decrypterFeaturesStore values and retain the prior value in memory... some other functionalityQuick Startfromeasy_caesarimportExamplea=Example()a.get_value()# 10InstallationStable Release:pip install easy_caesarDevelopment Head:pip install git+https://github.com/kyo91/easy_caesar.gitDocumentationFor full package documentation please visitkyo91.github.io/easy_caesar.DevelopmentSeeCONTRIBUTING.mdfor information related to developing the code.The Four Commands You Need To Knowpip install -e .[dev]This will install your package in editable mode with all the required development
dependencies (i.e.tox).make buildThis will runtoxwhich will run all your tests in both Python 3.7
and Python 3.8 as well as linting your code.make cleanThis will clean up various Python and build generated files so that you can ensure
that you are working in a clean environment.make docsThis 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 havegitinstalled, if you don't,follow these instructionsMake an account ongithub.comGo tomake a new repositoryRecommendations:It is strongly recommended to make the repository name the same as the Python
package nameA lot of the following optional steps arefreeif the repository is Public,
plus open source is coolAfter a GitHub repo has been created, run the following commands:git remote add origin git@github.com:kyo91/easy_caesar.gitgit push -u origin masterRegister easy_caesar with Codecov:Make an account oncodecov.io(Recommended to sign in with GitHub)Selectkyo91and click:Add new repositoryCopy the token provided, go to yourGitHub repository's settings and under theSecretstab,
add a secret calledCODECOV_TOKENwith 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 workGo to yourGitHub account's Personal Access Tokens pageClick:Generate new tokenRecommendations:Name the token: "Auto-Documentation Generation" or similar so you know what it
is being used for laterSelect only:repo:status,repo_deployment, andpublic_repoto limit what
this token has access toCopy the newly generated tokenGo to yourGitHub repository's settings and under theSecretstab,
add a secret calledACCESS_TOKENwith 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 onpypi.orgGo to yourGitHub repository's settings and under theSecretstab,
add a secret calledPYPI_TOKENwith 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 tostableit is recommended to install and runbumpversionas this will,
tag a git commit for release and update thesetup.pyversion number.Add branch protections tomasterandstableTo protect from just anyone pushing tomasterorstable(the branches with
more tests and deploy
configurations)Go to yourGitHub repository's settings and under theBranchestab, clickAdd ruleand select the
settings you believe best.Recommendations:Require pull request reviews before mergingRequire status checks to pass before merging (Recommended: lint and test)Suggested Git Branch Strategymasteris 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.stableis for releases only. When you want to release your project on PyPI, simply
make a PR frommastertostable, this template will handle the rest as long as you
have added your PyPI information described in the aboveOptional Stepssection.Your day-to-day work should exist on branches separate frommaster. Even if it is
just yourself working on the repository, make a PR from your working branch tomasterso 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 tomasteratomic and as a side effect naturally encourages small
well defined PR's.GitHub's UI is bad for rebasingmasterontostable, 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