MozDef/mozdef_util
dependabot[bot] 5c62c753e6
Bump pip from 18.1 to 19.2 in /mozdef_util (#1718)
Bumps [pip](https://github.com/pypa/pip) from 18.1 to 19.2.
- [Release notes](https://github.com/pypa/pip/releases)
- [Changelog](https://github.com/pypa/pip/blob/main/NEWS.rst)
- [Commits](https://github.com/pypa/pip/compare/18.1...19.2)

---
updated-dependencies:
- dependency-name: pip
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-11 14:25:17 -05:00
..
mozdef_util
.gitignore
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.rst
requirements_dev.txt
setup.py

README.rst

===========
MozDef Util
===========


Utilities shared throughout the MozDef codebase


* Usage Documentation: https://mozdef.readthedocs.io/en/latest/mozdef_util.html

Before a New release
--------------------

#. Run *make clean* to remove any previous build data
#. Modify the version in the setup.py file.
#. Add the new version and list the changes in the HISTORY.md file

To Push a New Release
---------------------

This package contains a Makefile that will allow you to run the following commands:

#. If you haven't run *make clean* yet, do that before you run make release.
#. Run *make release* which will package and upload the release.

Additional options provided by the Makefile:

#. *make dist* builds source and wheel package
#. *make install* installs the package to the active Python's site-packages
#. *make lint* runs flake8 on the codebase