From a4957bb4b8ee5cc9ebfd8d9bf2540fb499d881d5 Mon Sep 17 00:00:00 2001 From: 8nhuman Date: Fri, 16 Dec 2022 13:16:02 +0300 Subject: [PATCH] Update README's --- .github/ISSUE_TEMPLATE/bug_report.md | 38 -------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/pull_request_template.md | 21 ---- CODE_OF_CONDUCT.md | 76 --------------- CONTRIBUTING.md | 63 ------------ PACKAGE_README.md | 113 ---------------------- README.md | 10 +- docs/source/conf.py | 4 +- randword/__init__.py | 2 +- setup.py | 6 +- 10 files changed, 11 insertions(+), 342 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/pull_request_template.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 PACKAGE_README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 9098e60..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,21 +0,0 @@ -# Description - -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -# How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration. - -- [ ] Test A -- [ ] Test B - -# Checklist: - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index e4bde76..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, 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. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -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. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at artem.bezmenov02@gmail.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 43d4b89..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,63 +0,0 @@ -# Contributing to [randword](https://github.com/8nhuman8/randword) - -We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - -- Reporting a bug -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer - -## We develop with [GitHub](https://github.com) - -We use [GitHub](https://github.com) to host code, to track issues and feature requests, as well as accept pull requests. - -## We use [Github Flow](https://guides.github.com/introduction/flow/), So All Code Changes Happen Through Pull Requests - -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/)). We actively welcome your pull requests: - -1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests. -3. If you've changed APIs, update the documentation. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue that pull request! - -## Any contributions you make will be under the MIT Software License - -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. - -## Report bugs using Github's [issues](https://github.com/8nhuman8/randword/issues) - -We use [GitHub issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues) to track public bugs. Report a bug by [opening a new issue](https://github.com/8nhuman8/randword/issues/new/choose); it's that easy! - -## Write bug reports with detail, background, and sample code - -**Great Bug Reports** tend to have: - -- A quick summary and/or background -- Steps to reproduce -- What you expected would happen -- What actually happens -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - -People *love* thorough bug reports. I'm not even kidding. - -## Styleguides - -### Use a consistent coding style - -### Git commit messages - -- Use the present tense ("Add feature" not "Added feature") -- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") -- Limit the first line to 72 characters or less -- Reference issues and pull requests liberally after the first line - -### Python styleguide - -If possible, stick to [PEP-8](https://www.python.org/dev/peps/pep-0008/), but don't bother too much :) - -## License - -By contributing, you agree that your contributions will be licensed under its [MIT License](https://github.com/8nhuman8/randword/blob/master/LICENSE). diff --git a/PACKAGE_README.md b/PACKAGE_README.md deleted file mode 100644 index afb781e..0000000 --- a/PACKAGE_README.md +++ /dev/null @@ -1,113 +0,0 @@ -# randword - -`A Python package for generation random English words` - -## Table of contents - -- [Installation](#installation) -- [Usage](#usage) -- [Credits and references](#credits-and-references) -- [License](#license) -- [Contributing to randword](#contributing-to-randword) - -## Installation - -You can install `randword` package using `pip` or `easy_install`: - -``` -pip install randword -``` - -``` -easy_install randword -``` - -You can also just clone the repository and run: - -``` -python setup.py install -``` - -## Usage - -See the [documentation](https://randword.readthedocs.io/en/stable/index.html). - -## Credits and references - -- A database of words for each part of the speech was taken from [WordNet](https://wordnet.princeton.edu/). -- Splitting words into different parts of speech is made possible by [Chilli's answer](https://stackoverflow.com/a/27415226/13692774) on [Stack Overflow](https://stackoverflow.com/). -- Surnames database was taken from this [GitHub repo](https://github.com/arineng/arincli/blob/master/lib/last-names.txt). -- Male and females names were taken from the [website of Carnegie Mellon University](https://www.cs.cmu.edu/afs/cs/project/ai-repository/ai/areas/nlp/corpora/names/). -- Countries database was taken from [this GitHub gist](https://gist.github.com/kalinchernev/486393efcca01623b18d). -- Cities database was taken from [this GitHub gist](https://gist.github.com/norcal82/4accc0d968444859b408). -- Magic 8-Ball answers were taken from [Wikipedia page](https://en.wikipedia.org/wiki/Magic_8-Ball). - -## License - -[randword](https://github.com/8nhuman8/randword) specific code is distributed under [MIT License](https://github.com/8nhuman8/randword/blob/master/LICENSE.txt). - -Copyright (c) 2020 Artyom Bezmenov - -# Contributing to [randword](https://github.com/8nhuman8/randword) - -We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - -- Reporting a bug -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer - -## We develop with [GitHub](https://github.com) - -We use [GitHub](https://github.com) to host code, to track issues and feature requests, as well as accept pull requests. - -## We use [Github Flow](https://guides.github.com/introduction/flow/), So All Code Changes Happen Through Pull Requests - -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/)). We actively welcome your pull requests: - -1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests. -3. If you've changed APIs, update the documentation. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue that pull request! - -## Any contributions you make will be under the MIT Software License - -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. - -## Report bugs using Github's [issues](https://github.com/8nhuman8/randword/issues) - -We use [GitHub issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues) to track public bugs. Report a bug by [opening a new issue](https://github.com/8nhuman8/randword/issues/new/choose); it's that easy! - -## Write bug reports with detail, background, and sample code - -**Great Bug Reports** tend to have: - -- A quick summary and/or background -- Steps to reproduce -- What you expected would happen -- What actually happens -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - -People *love* thorough bug reports. I'm not even kidding. - -## Styleguides - -### Use a consistent coding style - -### Git commit messages - -- Use the present tense ("Add feature" not "Added feature") -- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") -- Limit the first line to 72 characters or less -- Reference issues and pull requests liberally after the first line - -### Python styleguide - -If possible, stick to [PEP-8](https://www.python.org/dev/peps/pep-0008/), but don't bother too much :) - -## License - -By contributing, you agree that your contributions will be licensed under its [MIT License](https://github.com/8nhuman8/randword/blob/master/LICENSE.txt). diff --git a/README.md b/README.md index 641252c..3bd9cf9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # randword -`A Python package for generation random English words` +The Python package for generating random English words ## Table of contents @@ -13,17 +13,17 @@ You can install `randword` package using `pip` or `easy_install`: -``` +```bash pip install randword ``` -``` +```bash easy_install randword ``` You can also just clone the repository and run: -``` +```bash python setup.py install ``` @@ -45,4 +45,4 @@ See the [documentation](https://randword.readthedocs.io/en/stable/index.html). [randword](https://github.com/8nhuman8/randword) specific code is distributed under [MIT License](https://github.com/8nhuman8/randword/blob/master/LICENSE.txt). -Copyright (c) 2020 Artyom Bezmenov +Copyright (c) 2022 Artyom Bezmenov diff --git a/docs/source/conf.py b/docs/source/conf.py index 9b49181..ccf47dc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,9 +9,9 @@ project = 'randword' copyright = '2022, Artyom Bezmenov' -author = 'Artyom Bezmenov' +author = 'Artyom Bezmenov (8nhuman)' -release = '2.11' +release = '2.11.1' # -- General configuration --------------------------------------------------- diff --git a/randword/__init__.py b/randword/__init__.py index 525f2f0..2a36c20 100644 --- a/randword/__init__.py +++ b/randword/__init__.py @@ -1,5 +1,5 @@ ''' -A module that provides the generation of various information. +The Python module for generating random English words. ''' from .rand_word import PARTS_OF_SPEECH, word diff --git a/setup.py b/setup.py index 8ae665f..0a65d06 100644 --- a/setup.py +++ b/setup.py @@ -1,14 +1,14 @@ from setuptools import setup -with open('PACKAGE_README.md', 'r') as readme_file: +with open('README.md', 'r') as readme_file: long_description = readme_file.read() -VERSION = '2.11' +VERSION = '2.11.1' setup( name='randword', - description='A Python package for generation random English words', + description='The Python package for generating random English words', long_description=long_description, long_description_content_type='text/markdown', keywords=[