version to 1.0. update coc, license, readme

Author: cscorley

CODE_OF_CONDUCT.md

@@ -1,50 +1,130 @@
-# Contributor Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+# Contributor Covenant Code of Conduct
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+## Our Pledge
 
-Examples of unacceptable behavior by participants include:
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at [[email protected]]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

HISTORY.md

@@ -1,11 +1,16 @@
 # next
 
+- Your PR goes here :)
+
+# 1.0.0
+
 - Issue #26 fix where hardcoded "/tmp" reference was being used
 - Support up to Python 3.8
 - Drop support for Python 2, 3.4
 
 Dev-only:
 
+- Bump Code of Conduct to 2.0
 - Setup Github Actions for package publishing
 - Setup Github Actions for build and testing
   - Move off Travis and Tox in favor of Github Actions

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012 -- 2015 Christopher S. Corley
+Copyright (c) 2012 -- 2020 Christopher S. Corley
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

Makefile

@@ -1,12 +1,28 @@
 What The Patch!?
 ================
 
+What The Patch!? is a library for both parsing and applying patch files.
+
+Status
+------
+
 .. image:: https://github.com/cscorley/whatthepatch/workflows/Build/badge.svg
 
-What The Patch!? is a library for both parsing and applying patch files.
+This has been released as 1.0, but has never had much active development. The
+functions are stable and have been reliable for several years, even if they
+are not ideally implemented. Pull requests will always be considered, merged,
+and released; however, issues may not ever be fixed by the maintainer.
+
+Contribute
+^^^^^^^^^^
+
+#. Fork this repository
+#. Create a new branch to work on
+#. Commit your tests and/or changes
+#. Push and create a pull request here!
 
 Features
----------
+--------
 
 - Parsing of almost all ``diff`` formats (except forwarded ed):
 
@@ -25,7 +41,8 @@ Features
 Installation
 ------------
 
-To install What The Patch!?, simply:
+This library is available on `PyPI <https://pypi.org/project/whatthepatch/>`_
+and can be installed via pip:
 
 .. code-block:: bash
 
@@ -141,15 +158,8 @@ To apply a diff to some lines of text, first read the patch and parse it.
      'Deeper and more profound,',
      'The door of all subtleties!']
 
-If apply does not satisfy your needs and you are on a system that has `patch`
-in `PATH`, you can also call `apply_diff(diff, lao, use_patch=True)`. The
-default is False, and patch is not necessary to apply diffs to text.
-
-Contribute
-==========
-
-#. Fork this repository
-#. Create a new branch to work on
-#. Commit your tests and/or changes
-#. Push and create a pull request here!
+If apply does not satisfy your needs and you are on a system that has
+``patch`` in ``PATH``, you can also call ``apply_diff(diff, lao,
+use_patch=True)``. The default is false, and patch is not necessary to apply
+diffs to text.
 

README.rst

@@ -11,12 +11,11 @@
 
 setup(
     name="whatthepatch",
-    version="0.0.6",
+    version="1.0.0",
     author="Christopher S. Corley",
-    author_email="cscorley@crimson.ua.edu",
+    author_email="cscorley@gmail.com",
     description="A patch parsing and application library.",
     long_description=readme,
-    long_description_content_type="text/markdown",
     url="https://github.com/cscorley/whatthepatch",
     license="MIT",
     packages=["whatthepatch"],
@@ -25,7 +24,7 @@
     classifiers=[
         "Operating System :: OS Independent",
         "License :: OSI Approved :: MIT License",
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "Intended Audience :: Science/Research",
         "Topic :: Software Development",