Updated config for readthedocs deploys

Signed-off-by: Omkar Phansopkar <[email protected]>

docs/.readthedocs.yml → .readthedocs.yml

@@ -21,9 +21,15 @@ sphinx:
  configuration: docs/source/conf.py
 
 # Setting the python version and doc build requirements
+# python:
+# install:
+# - requirements: docs/requirements.txt
+# - requirements: requirements.txt
+
 python:
  install:
  - method: pip
  path: .
  extra_requirements:
- - docs
+ - docs
+

CODE_OF_CONDUCT.rst

@@ -0,0 +1,86 @@
+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, 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 [email protected]
+or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss .
+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`_ ,
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+.. _Contributor Covenant: https://www.contributor-covenant.org

pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools >= 50", "wheel", "setuptools_scm[toml] >= 6"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+# this is used populated when creating a git archive
+# and when there is .git dir and/or there is no git installed
+fallback_version = "9999.$Format:%h-%cs$"
+
+[tool.pytest.ini_options]
+norecursedirs = [
+ ".git",
+ "bin",
+ "dist",
+ "build",
+ "_build",
+ "dist",
+ "etc",
+ "local",
+ "ci",
+ "docs",
+ "man",
+ "share",
+ "samples",
+ ".cache",
+ ".settings",
+ "Include",
+ "include",
+ "Lib",
+ "lib",
+ "lib64",
+ "Lib64",
+ "Scripts",
+ "thirdparty",
+ "tmp",
+ "venv",
+ "tests/data",
+ ".eggs",
+ "src/*/data",
+ "tests/*/data"
+]
+
+python_files = "*.py"
+
+python_classes = "Test"
+python_functions = "test"
+
+addopts = [
+ "-rfExXw",
+ "--strict-markers",
+ "--doctest-modules"
+]

requirements.txt

@@ -0,0 +1,3 @@
+# Install all the requirements needed for documentation
+
+-r docs/requirements.txt

setup.cfg

@@ -0,0 +1,48 @@
+[metadata]
+name = Scancode Workbench
+license = Apache-2.0
+
+description = ScanCode Workbench provides an advanced visual UI to help you quickly evaluate license and other notices identified by ScanCode Toolkit
+long_description = file:README.rst
+long_description_content_type = text/x-rst
+url = https://github.com/nexB/scancode-workbench
+
+author = nexB. Inc. and others
+author_email = [email protected]
+
+classifiers =
+ Development Status :: 5 - Production/Stable
+ Intended Audience :: Developers
+ Programming Language :: Python :: 3
+ Programming Language :: Python :: 3 :: Only
+ Topic :: Software Development
+ Topic :: Utilities
+
+keywords =
+ utilities
+
+license_files =
+ apache-2.0.LICENSE
+ NOTICE
+ CHANGELOG.rst
+ CODE_OF_CONDUCT.rst
+
+[options]
+package_dir =
+ =src
+packages = find:
+include_package_data = true
+zip_safe = false
+
+setup_requires = setuptools_scm[toml] >= 4
+
+python_requires = >=3.7
+
+install_requires =
+
+[options.extras_require]
+docs =
+ Sphinx>=5.0.2
+ sphinx-rtd-theme>=1.0.0
+ sphinx-reredirects >= 0.1.2
+ doc8>=0.11.2