Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop Python 2 support #22

Merged
merged 23 commits into from
Dec 2, 2023
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
1e6bf37
Reformat sections.py
duckduckgrayduck Nov 26, 2023
376f2b0
Reformat addon.py
duckduckgrayduck Nov 26, 2023
bc3caaf
Reformat annotations.py
duckduckgrayduck Nov 26, 2023
068d507
Reformat base.py
duckduckgrayduck Nov 26, 2023
4b9c003
Reformat client.py
duckduckgrayduck Nov 26, 2023
68063d1
Reformat constants.py
duckduckgrayduck Nov 26, 2023
47733bb
Reformat documents.py
duckduckgrayduck Nov 26, 2023
ade862e
Reformat exceptions.py
duckduckgrayduck Nov 26, 2023
6f13ce7
Reformat organizations.py
duckduckgrayduck Nov 26, 2023
635aab8
Reformat projects.py
duckduckgrayduck Nov 26, 2023
418cbe1
Reformat toolbox.py
duckduckgrayduck Nov 26, 2023
5a03355
Reformat users.py
duckduckgrayduck Nov 26, 2023
0ae8149
Ran black, pylint, fixed some strings, changed versions supported in …
duckduckgrayduck Nov 26, 2023
39d48ba
Add / to save()
duckduckgrayduck Nov 29, 2023
3a0c6bc
Get tests to pass
duckduckgrayduck Nov 29, 2023
f4a1c73
Merge remote-tracking branch 'upstream/master'
duckduckgrayduck Nov 29, 2023
ba9b948
Ran black & pylint, bumped version in setup.py and changelog
duckduckgrayduck Nov 29, 2023
0a79cbc
Removed old add.py.confg
duckduckgrayduck Nov 29, 2023
b6848d9
pylint
mitchelljkotler Nov 30, 2023
287e29d
Fixed r! and lazy formatting for logs
duckduckgrayduck Dec 2, 2023
38fe0e0
Merge pull request #1 from MuckRock/duck
duckduckgrayduck Dec 2, 2023
751f1fc
Silence one last pylint warning
duckduckgrayduck Dec 2, 2023
3d197ac
Fix documentation for mentions
duckduckgrayduck Dec 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ max-line-length=88
good-names=i,x1,x2,y1,y2

[MESSAGES CONTROL]
disable=missing-docstring,too-many-ancestors,too-few-public-methods,bad-continuation,no-else-return,no-member,attribute-defined-outside-init,no-self-use,similarities,import-outside-toplevel,cyclic-import,no-member,no-else-raise,too-many-instance-attributes,too-many-arguments,ungrouped-imports,useless-object-inheritance,no-else-continue
disable=missing-docstring,too-many-ancestors,too-few-public-methods,no-else-return,no-member,attribute-defined-outside-init,similarities,import-outside-toplevel,cyclic-import,no-member,no-else-raise,too-many-instance-attributes,too-many-arguments,ungrouped-imports,useless-object-inheritance,no-else-continue
5 changes: 5 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Changelog
---------

4.0.0
~~~~~
* Removes support for Python2


3.8.0
~~~~~
* Add `charge_credits` to `AddOn`
Expand Down
154 changes: 84 additions & 70 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,224 +22,232 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = u'documentcloud'
copyright = u'2020, MuckRock Foundation'
project = "documentcloud"
copyright = "2023, MuckRock Foundation"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '3.7.1'
version = "4.0"
# The full version, including alpha/beta/rc tags.
release = '3.7.1'
release = "4.0.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'links.rst']
exclude_patterns = ["_build", "links.rst"]

# Read link all targets from file
with open('links.rst') as f:
with open("links.rst") as f:
rst_epilog = f.read()

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# keep_warnings = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = "default"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'python-documentclouddoc'
htmlhelp_basename = "python-documentclouddoc"


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'python-documentcloud.tex', u'python-documentcloud Documentation',
u'Los Angeles Times Data Desk', 'manual'),
(
"index",
"python-documentcloud.tex",
"python-documentcloud Documentation",
"Los Angeles Times Data Desk",
"manual",
),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'python-documentcloud', u'python-documentcloud Documentation',
[u'Los Angeles Times Data Desk'], 1)
(
"index",
"python-documentcloud",
"python-documentcloud Documentation",
["Los Angeles Times Data Desk"],
1,
)
]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -248,19 +256,25 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'python-documentcloud', u'python-documentcloud Documentation',
u'Los Angeles Times Data Desk', 'python-documentcloud', 'One line description of project.',
'Miscellaneous'),
(
"index",
"python-documentcloud",
"python-documentcloud Documentation",
"Los Angeles Times Data Desk",
"python-documentcloud",
"One line description of project.",
"Miscellaneous",
),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False
11 changes: 3 additions & 8 deletions documentcloud/annotations.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
# Future
from __future__ import division, print_function, unicode_literals

# Third Party
from future.utils import python_2_unicode_compatible
from listcrunch.listcrunch import uncrunch

# Local
from .base import BaseAPIObject, ChildAPIClient
from .toolbox import merge_dicts


@python_2_unicode_compatible
class Annotation(BaseAPIObject):
"""A note on a document"""

Expand All @@ -30,7 +25,7 @@ def __str__(self):

@property
def api_path(self):
return "documents/{}/notes".format(self.document.id)
return f"documents/{self.document.id}/notes"

@property
def location(self):
Expand Down Expand Up @@ -71,7 +66,7 @@ class AnnotationClient(ChildAPIClient):

@property
def api_path(self):
return "documents/{}/notes".format(self.parent.id)
return f"documents/{self.parent.id}/notes"

def create(
self,
Expand Down Expand Up @@ -102,7 +97,7 @@ def create(
"x2": x2,
"y2": y2,
}
response = self.client.post(self.api_path + "/", json=data)
response = self.client.post(f"{self.api_path}/", json=data)
return Annotation(
self.client, merge_dicts(response.json(), {"document": self.parent})
)
Loading
Loading