Changes

CW Release Steps

951 bytes added, 20:00, 25 January 2017
Pushing to PyPi
This page contains various information regarding the ChipWhisperer release steps. This is not designed for users, but as a note for developers regarding release information.
 
==Release Steps==
 
=== Pushing to PyPi ===
 
To allow users to perform a glorious:
 
pip install chipwhisperer
 
We push '''part''' of the release to pypi. This partial release only includes the Python software, and not the complete ChipWhisperer repo (with hardware, docs, etc).
 
We follow a basic tutorial from [http://peterdowns.com/posts/first-time-with-pypi.html], which includes a fairly basic setup.py. Important details to note:
 
* Adding new modules requires adding them to setup.py to ensure they are included
 
Once a new release is ready, it's a simple case of:
 
python setup.py sdist upload
 
To push to the real pypi server. This step can only be performed by someone with authentication access to pypi (probably Colin).
 
See also: [http://peterdowns.com/posts/first-time-with-pypi.html]
 
==Other Notes==
=== GIT Repo Sync ===
git push -u github master
4. Add the following to the .gitignore file, as this file is in the root of the GITHub repo but we don't want to track:  README.md 5. Make above executable for user script will run as (ideally this was all setup as someone with low/no privileges since they need no access elsewhere).
56. Use "crontab -e" to add task that runs every 5 mins and runs that script:
0,5,10,15,20,25,30,35,40,45,50,55 * * * * cd /home/someone/somewhere/chipwhisperer; ./pullpush.sh
Approved_users
510
edits