Packaging my CLI

 Creating a Python Package

The first steps I had to take to package my python CLI was to reorganize my directory structure. This involved moving my main python files into a separate folder and after running into some errors I also had to change the import statements in those python files to match the changes made to the directory. Once that was done I was ready to begin packaging my CLI. In this guide I used the next steps were to update my setup.py so it could be used in the next steps to create my package. In my setup.py I had to include all the other packages that needed to be installed to run my CLI, as well as open and read my  README file to be included as well. Once my setup.py was ready I was no ready to create my package by using the setuptools and wheel package with the command python3 setup.py sdist bdist_wheel. This command created to files in a dist folder, the first file was the source distribution and the second file was the built distribution. Now my package was ready to be uploaded. 

Uploading my Python Package

First I needed to register at https://pypi.org. Once my account was created I needed to get an API Token and use this token with the command python -m twine upload dist/* which uploaded my CLI to the python package index which now allowed me to install my package with the command pip install deadOrNot. 

Issues, Bugs and Further Releases

Once I installed my first release and tried running in a different environment I ran into a few issues. The first was that I did not include all the needed dependencies in the setup.py file which caused the package to fail. Another was one I mentioned earlier where the import statements were not working correctly after changing my directory structure. Once I was able to fix these issues I uploaded two new versions of the package following the instructions above. 

User Testing

After updating my README file I tried to get my friend to install and run my CLI. Surprisingly this went pretty well and he was able to get it running fairly simply. The only issue was that I didn't make mention of installing python.

Comments

Post a Comment

Popular posts from this blog

Adding Features and Pull Request

Week 3 OSD600 - Pull Requests   This week, our class took a look at each other's release from the previous week and were tasked with finding an issue or suggesting an improvement/adding a feature and then implementing that fix or improvement in the from of a  pull request. This week I decided to once again took a look at Matt's CheckMyLinks python tool.  Finding Issues or Suggesting an Improvement While reviewing Matt's code, I couldn't really find any issues that I could fix, so I instead I decided to look for ways I could think of to improve his tool. I had a couple ideas but the one I decided to go with was to add an option that would allow the user to save the results of the link check to a text file. I thought this would be useful so the user can have a reference of the results after leaving the command line. I left an issue request on Matt's repo and began to implement the improvement.  Implementing Improvement   The first thing I did when starting to code t
Read more

Planning for Release 0.4

 For this final release I was able to find a project that has created a reddit bot that scans titles in reddit subreddits and if it matches the criteria laid out in the code it offers the poster some useful resources and/or some great projects to begin practicing coding. I thought this was a worthwhile project as this is something that would definitely be helpful to me and it seems like a great addition to the programming  community.  The specific issue that I wanted to work on was one were the creator of the bot had all the code for the bot basically in one python file and the file was growing to over 500 lines and he wanted to move to a more modular approach that would include separating out the logic into different files. I thought this would be a good issue to tackle because it would require me to get a full understanding of the code as well as add optimizations throughout while a separated out the code.  The approach I plan to take is first to review the code so I can get a more
Read more

Release 0.2 3rd Pull Request

Introduction For this pull request, I wanted to build the confidence to work with a larger open source project. I was able to find the perfect oppurtunity to build my confidence in working in larger more complex projects with Pandas. Pandas is a data analysis tool that I have used before with python and it was powerful and highly recommended so contributing to the project was something that really interested me.  Issue  The code base for pandas was pretty complex and intimidating so for my first contribution I wanted to find an issue that was fairly simple just so I could get a feel for the contributing process for such a larger project. I was able to find an issue that had been filed that was marked as good for first time contributors. The issue  was that they had several files that they wanted to move away from using dict() to create dictionaries and instead used python literal dicts to avoid having to ignore the flake8 errors they caused. Fixing this would be fairly simple so I pick
Read more