Skip to content

Commit 35d2a27

Browse files
OmkarPhOmkarPh
committed
Updated config for readthedocs deploys
Signed-off-by: Omkar Phansopkar <[email protected]>
1 parent d86c93f commit 35d2a27

File tree

6 files changed

+197
-7
lines changed

6 files changed

+197
-7
lines changed

‎docs/.readthedocs.yml‎ renamed to ‎.readthedocs.yml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@
55
# Required
66
version: 2
77

8-
# Build in latest ubuntu/python
9-
build:
10-
os: ubuntu-22.04
11-
tools:
12-
python: "3.11"
13-
148
# Build PDF & ePub
159
formats:
1610
- epub
@@ -20,10 +14,17 @@ formats:
2014
sphinx:
2115
configuration: docs/source/conf.py
2216

17+
# specify build OS
18+
build:
19+
os: ubuntu-22.04
20+
tools:
21+
python: "3.11"
22+
2323
# Setting the python version and doc build requirements
2424
python:
2525
install:
2626
- method: pip
2727
path: .
2828
extra_requirements:
29-
- docs
29+
- docs
30+

‎CODE_OF_CONDUCT.rst‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our
9+
project and our community a harassment-free experience for everyone,
10+
regardless of age, body size, disability, ethnicity, gender identity and
11+
expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, religion, or sexual identity and
13+
orientation.
14+
15+
Our Standards
16+
-------------
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
- Using welcoming and inclusive language
22+
- Being respectful of differing viewpoints and experiences
23+
- Gracefully accepting constructive criticism
24+
- Focusing on what is best for the community
25+
- Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
- The use of sexualized language or imagery and unwelcome sexual
30+
attention or advances
31+
- Trolling, insulting/derogatory comments, and personal or political
32+
attacks
33+
- Public or private harassment
34+
- Publishing others’ private information, such as a physical or
35+
electronic address, without explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
Our Responsibilities
40+
--------------------
41+
42+
Project maintainers are responsible for clarifying the standards of
43+
acceptable behavior and are expected to take appropriate and fair
44+
corrective action in response to any instances of unacceptable behavior.
45+
46+
Project maintainers have the right and responsibility to remove, edit,
47+
or reject comments, commits, code, wiki edits, issues, and other
48+
contributions that are not aligned to this Code of Conduct, or to ban
49+
temporarily or permanently any contributor for other behaviors that they
50+
deem inappropriate, threatening, offensive, or harmful.
51+
52+
Scope
53+
-----
54+
55+
This Code of Conduct applies both within project spaces and in public
56+
spaces when an individual is representing the project or its community.
57+
Examples of representing a project or community include using an
58+
official project e-mail address, posting via an official social media
59+
account, or acting as an appointed representative at an online or
60+
offline event. Representation of a project may be further defined and
61+
clarified by project maintainers.
62+
63+
Enforcement
64+
-----------
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may
67+
be reported by contacting the project team at [email protected]
68+
or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss .
69+
All complaints will be reviewed and investigated and will result in a
70+
response that is deemed necessary and appropriate to the circumstances.
71+
The project team is obligated to maintain confidentiality with regard to
72+
the reporter of an incident. Further details of specific enforcement
73+
policies may be posted separately.
74+
75+
Project maintainers who do not follow or enforce the Code of Conduct in
76+
good faith may face temporary or permanent repercussions as determined
77+
by other members of the project’s leadership.
78+
79+
Attribution
80+
-----------
81+
82+
This Code of Conduct is adapted from the `Contributor Covenant`_ ,
83+
version 1.4, available at
84+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
85+
86+
.. _Contributor Covenant: https://www.contributor-covenant.org

‎LICENSE‎ renamed to ‎apache-2.0.LICENSE‎

File renamed without changes.

‎pyproject.toml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[build-system]
2+
requires = ["setuptools >= 50", "wheel", "setuptools_scm[toml] >= 6"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[tool.setuptools_scm]
6+
# this is used populated when creating a git archive
7+
# and when there is .git dir and/or there is no git installed
8+
fallback_version = "9999.$Format:%h-%cs$"
9+
10+
[tool.pytest.ini_options]
11+
norecursedirs = [
12+
".git",
13+
"bin",
14+
"dist",
15+
"build",
16+
"_build",
17+
"dist",
18+
"etc",
19+
"local",
20+
"ci",
21+
"docs",
22+
"man",
23+
"share",
24+
"samples",
25+
".cache",
26+
".settings",
27+
"Include",
28+
"include",
29+
"Lib",
30+
"lib",
31+
"lib64",
32+
"Lib64",
33+
"Scripts",
34+
"thirdparty",
35+
"tmp",
36+
"venv",
37+
"tests/data",
38+
".eggs",
39+
"src/*/data",
40+
"tests/*/data"
41+
]
42+
43+
python_files = "*.py"
44+
45+
python_classes = "Test"
46+
python_functions = "test"
47+
48+
addopts = [
49+
"-rfExXw",
50+
"--strict-markers",
51+
"--doctest-modules"
52+
]

‎setup.cfg‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[metadata]
2+
name = Scancode Workbench
3+
license = Apache-2.0
4+
5+
description = ScanCode Workbench provides an advanced visual UI to help you quickly evaluate license and other notices identified by ScanCode Toolkit
6+
long_description = file:README.rst
7+
long_description_content_type = text/x-rst
8+
url = https://github.com/nexB/scancode-workbench
9+
10+
author = nexB. Inc. and others
11+
author_email = [email protected]
12+
13+
classifiers =
14+
Development Status :: 5 - Production/Stable
15+
Intended Audience :: Developers
16+
Programming Language :: Python :: 3
17+
Programming Language :: Python :: 3 :: Only
18+
Topic :: Software Development
19+
Topic :: Utilities
20+
21+
keywords =
22+
utilities
23+
24+
license_files =
25+
apache-2.0.LICENSE
26+
NOTICE
27+
CHANGELOG.rst
28+
CODE_OF_CONDUCT.rst
29+
30+
[options]
31+
package_dir =
32+
=src
33+
packages = find:
34+
include_package_data = true
35+
zip_safe = false
36+
37+
setup_requires = setuptools_scm[toml] >= 4
38+
39+
python_requires = >=3.7
40+
41+
install_requires =
42+
43+
[options.extras_require]
44+
docs =
45+
-r docs/requirements.txt

‎setup.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env python
2+
3+
import setuptools
4+
5+
if __name__ == "__main__":
6+
setuptools.setup()

0 commit comments

Comments
 (0)