diff --git a/.buildinfo b/.buildinfo deleted file mode 100644 index a2d6289..0000000 --- a/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 30f1ebf298a69af07a3aaa84d64774e9 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/repo_stats/user_stats.html b/_modules/repo_stats/user_stats.html index ae782e5..5c27805 100644 --- a/_modules/repo_stats/user_stats.html +++ b/_modules/repo_stats/user_stats.html @@ -85,7 +85,7 @@

Source code for repo_stats.user_stats

 
[docs] class StatsImage: - def __init__(self, template_image, font, text_color="#b2b2b2"): + def __init__(self, template_image, font, text_color="#ff5804"): """ Class for updating a template image (e.g. to be displayed in a GitHub README) with repository and citation statistics. diff --git a/py_API.html b/py_API.html index 94bf66c..ed22ca6 100644 --- a/py_API.html +++ b/py_API.html @@ -511,7 +511,7 @@

runner<

user_stats

-class repo_stats.user_stats.StatsImage(template_image, font, text_color='#b2b2b2')[source]
+class repo_stats.user_stats.StatsImage(template_image, font, text_color='#ff5804')[source]

Class for updating a template image (e.g. to be displayed in a GitHub README) with repository and citation statistics.

Parameters:
diff --git a/searchindex.js b/searchindex.js index 961a3f1..6e12e60 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Documentation": [[0, null]], "Reference": [[0, null]], "citation_metrics": [[1, "citation-metrics"]], "git_metrics": [[1, "git-metrics"]], "plot": [[1, "plot"]], "repo_stats API": [[1, null]], "runner": [[1, "runner"]], "user_stats": [[1, "user-stats"]], "utilities": [[1, "utilities"]]}, "docnames": ["index", "py_API"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "py_API.rst"], "indexentries": {"adscitations (class in repo_stats.citation_metrics)": [[1, "repo_stats.citation_metrics.ADSCitations", false]], "aggregate_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.aggregate_citations", false]], "author_time_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.author_time_plot", false]], "citation_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.citation_plot", false]], "draw_text() (repo_stats.user_stats.statsimage method)": [[1, "repo_stats.user_stats.StatsImage.draw_text", false]], "fill_missed_months() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.fill_missed_months", false]], "get_age() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_age", false]], "get_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.get_citations", false]], "get_commits() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_commits", false]], "get_commits_via_git_log() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_commits_via_git_log", false]], "get_issues_prs() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_issues_PRs", false]], "gitmetrics (class in repo_stats.git_metrics)": [[1, "repo_stats.git_metrics.GitMetrics", false]], "issue_pr_time_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.issue_PR_time_plot", false]], "main() (in module repo_stats.runner)": [[1, "repo_stats.runner.main", false]], "open_issue_pr_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.open_issue_PR_plot", false]], "parse_log_line() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.parse_log_line", false]], "parse_parameters() (in module repo_stats.runner)": [[1, "repo_stats.runner.parse_parameters", false]], "process_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.process_citations", false]], "process_commits() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.process_commits", false]], "process_issues_prs() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.process_issues_PRs", false]], "rolling_average() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.rolling_average", false]], "statsimage (class in repo_stats.user_stats)": [[1, "repo_stats.user_stats.StatsImage", false]], "update_cache() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.update_cache", false]], "update_image() (repo_stats.user_stats.statsimage method)": [[1, "repo_stats.user_stats.StatsImage.update_image", false]]}, "objects": {"repo_stats.citation_metrics": [[1, 0, 1, "", "ADSCitations"]], "repo_stats.citation_metrics.ADSCitations": [[1, 1, 1, "", "aggregate_citations"], [1, 1, 1, "", "get_citations"], [1, 1, 1, "", "process_citations"]], "repo_stats.git_metrics": [[1, 0, 1, "", "GitMetrics"]], "repo_stats.git_metrics.GitMetrics": [[1, 1, 1, "", "get_age"], [1, 1, 1, "", "get_commits"], [1, 1, 1, "", "get_commits_via_git_log"], [1, 1, 1, "", "get_issues_PRs"], [1, 1, 1, "", "parse_log_line"], [1, 1, 1, "", "process_commits"], [1, 1, 1, "", "process_issues_PRs"]], "repo_stats.plot": [[1, 2, 1, "", "author_time_plot"], [1, 2, 1, "", "citation_plot"], [1, 2, 1, "", "issue_PR_time_plot"], [1, 2, 1, "", "open_issue_PR_plot"]], "repo_stats.runner": [[1, 2, 1, "", "main"], [1, 2, 1, "", "parse_parameters"]], "repo_stats.user_stats": [[1, 0, 1, "", "StatsImage"]], "repo_stats.user_stats.StatsImage": [[1, 1, 1, "", "draw_text"], [1, 1, 1, "", "update_image"]], "repo_stats.utilities": [[1, 2, 1, "", "fill_missed_months"], [1, 2, 1, "", "rolling_average"], [1, 2, 1, "", "update_cache"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"": 1, "0": 1, "01": 1, "1": 1, "2013a": 1, "2024": 1, "33a": 1, "558a": 1, "7": 1, "90": 1, "A": 1, "For": 1, "One": 1, "The": 1, "across": 1, "ad": 1, "addit": 1, "adscit": 1, "ag": 1, "age_rec": 1, "age_recent_commit": 1, "aggreg": 1, "aggregate_cit": 1, "all": 1, "all_cit": 1, "all_item": 1, "all_stat": 1, "an": 1, "analysi": 1, "api": 0, "arg": 1, "argument": 1, "arrai": 1, "ascii": 1, "assum": 1, "author": 1, "author_time_plot": 1, "authors_per_month": 1, "averag": 1, "b2b2b2": 1, "bar": 1, "befor": 1, "being": 1, "below": 1, "bib": 1, "bibcod": 1, "break": 1, "cach": 1, "cache_dir": 1, "cache_fil": 1, "categor": 1, "chart": 1, "citat": 1, "citation_plot": 1, "cite": 1, "cite_al": 1, "cite_bibcod": 1, "cite_month": 1, "cite_per_year": 1, "cite_stat": 1, "cite_year": 1, "class": 1, "close": 1, "close_per_month": 1, "color": 1, "combin": 1, "command": 1, "commit": 1, "commit_stat": 1, "compon": 1, "contributor": 1, "conveni": 1, "coord": 1, "coordin": 1, "copi": 1, "correspond": 1, "count": 1, "current": 1, "dai": 1, "data": 1, "databas": 1, "date": 1, "datetim": 1, "days_sinc": 1, "decreas": 1, "default": 1, "dict": 1, "dictionari": 1, "directori": 1, "displai": 1, "doc": 0, "draw": 1, "draw_text": 1, "drawn": 1, "e": 1, "each": 1, "enforc": 1, "entri": 1, "exist": 1, "fig": 1, "figur": 1, "file": 1, "fill": 1, "fill_missed_month": 1, "first": 1, "font": 1, "format": 1, "from": 1, "g": 1, "gener": 1, "get": 1, "get_ag": 1, "get_cit": 1, "get_commit": 1, "get_commits_via_git_log": 1, "get_issues_pr": 1, "git": 1, "github": [0, 1], "gitmetr": 1, "given": 1, "graphql": 1, "hash": 1, "histori": 1, "i": 1, "identifi": 1, "imag": 1, "imagedraw": 1, "imagefont": 1, "img": 1, "includ": 1, "index": [0, 1], "indic": 1, "individu": 1, "input": 1, "insert": 1, "instanc": 1, "int": 1, "issu": 1, "issue_pr_stat": 1, "issue_pr_time_plot": 1, "issues_pr": 1, "item": 1, "item_typ": 1, "its": 1, "json": 1, "kwarg": 1, "label": 1, "label_open": 1, "legend": 1, "length": 1, "line": 1, "list": 1, "local": 1, "locat": 1, "log": 1, "main": 1, "make": 1, "metric": 1, "miss": 1, "month": 1, "multi_authors_per_month": 1, "n_recent_author": 1, "name": 1, "nasa": 1, "new": 1, "new_author": 1, "new_authors_per_month": 1, "new_item": 1, "none": 1, "np": 1, "number": 1, "obtain": 1, "odd": 1, "old_item": 1, "one": 1, "open": 1, "open_issue_pr_plot": 1, "open_per_month": 1, "option": 1, "organ": 1, "output": 1, "over": 1, "owner": 1, "paper": 1, "param": 1, "paramet": 1, "pars": 1, "parse_log_lin": 1, "parse_paramet": 1, "part": 1, "path": 1, "per": 1, "pil": 1, "plt": 1, "popul": 1, "potenti": 1, "present": 1, "previou": 1, "process": 1, "process_cit": 1, "process_commit": 1, "process_issues_pr": 1, "provid": 1, "pub": 1, "pubdat": 1, "pull": 1, "pullrequest": 1, "quer": 1, "queri": 1, "read": 1, "readm": 1, "recent": 1, "recent_clos": 1, "recent_open": 1, "refer": 1, "referenc": 1, "repo": 0, "repo_local_path": 1, "repo_nam": 1, "repo_own": 1, "repo_stat": 0, "repositori": 1, "request": 1, "respositori": 1, "result": 1, "return": 1, "return_count": 1, "roll": 1, "roll_avg": 1, "rolling_averag": 1, "run": 1, "savenam": 1, "see": 1, "self": 1, "separ": 1, "set": 1, "simul": 1, "slide": 1, "sourc": 1, "stat": 1, "statist": 1, "statsimag": 1, "str": 1, "string": 1, "summar": 1, "target": 1, "templat": 1, "template_imag": 1, "text": 1, "text_color": 1, "tff": 1, "thi": 1, "those": 1, "time": 1, "timedelta": 1, "titl": 1, "token": 1, "total": 1, "true": 1, "tupl": 1, "type": 1, "unaverag": 1, "uniqu": 1, "unique_author": 1, "unique_output": 1, "updat": 1, "update_cach": 1, "update_imag": 1, "us": 1, "welcom": 0, "where": 1, "which": 1, "width": 1, "window": 1, "window_avg": 1, "wrapper": 1, "x": 1, "y": 1, "year": 1}, "titles": ["Documentation", "repo_stats API"], "titleterms": {"api": 1, "citation_metr": 1, "document": 0, "git_metr": 1, "plot": 1, "refer": 0, "repo_stat": 1, "runner": 1, "user_stat": 1, "util": 1}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Documentation": [[0, null]], "Reference": [[0, null]], "citation_metrics": [[1, "citation-metrics"]], "git_metrics": [[1, "git-metrics"]], "plot": [[1, "plot"]], "repo_stats API": [[1, null]], "runner": [[1, "runner"]], "user_stats": [[1, "user-stats"]], "utilities": [[1, "utilities"]]}, "docnames": ["index", "py_API"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "py_API.rst"], "indexentries": {"adscitations (class in repo_stats.citation_metrics)": [[1, "repo_stats.citation_metrics.ADSCitations", false]], "aggregate_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.aggregate_citations", false]], "author_time_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.author_time_plot", false]], "citation_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.citation_plot", false]], "draw_text() (repo_stats.user_stats.statsimage method)": [[1, "repo_stats.user_stats.StatsImage.draw_text", false]], "fill_missed_months() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.fill_missed_months", false]], "get_age() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_age", false]], "get_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.get_citations", false]], "get_commits() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_commits", false]], "get_commits_via_git_log() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_commits_via_git_log", false]], "get_issues_prs() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.get_issues_PRs", false]], "gitmetrics (class in repo_stats.git_metrics)": [[1, "repo_stats.git_metrics.GitMetrics", false]], "issue_pr_time_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.issue_PR_time_plot", false]], "main() (in module repo_stats.runner)": [[1, "repo_stats.runner.main", false]], "open_issue_pr_plot() (in module repo_stats.plot)": [[1, "repo_stats.plot.open_issue_PR_plot", false]], "parse_log_line() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.parse_log_line", false]], "parse_parameters() (in module repo_stats.runner)": [[1, "repo_stats.runner.parse_parameters", false]], "process_citations() (repo_stats.citation_metrics.adscitations method)": [[1, "repo_stats.citation_metrics.ADSCitations.process_citations", false]], "process_commits() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.process_commits", false]], "process_issues_prs() (repo_stats.git_metrics.gitmetrics method)": [[1, "repo_stats.git_metrics.GitMetrics.process_issues_PRs", false]], "rolling_average() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.rolling_average", false]], "statsimage (class in repo_stats.user_stats)": [[1, "repo_stats.user_stats.StatsImage", false]], "update_cache() (in module repo_stats.utilities)": [[1, "repo_stats.utilities.update_cache", false]], "update_image() (repo_stats.user_stats.statsimage method)": [[1, "repo_stats.user_stats.StatsImage.update_image", false]]}, "objects": {"repo_stats.citation_metrics": [[1, 0, 1, "", "ADSCitations"]], "repo_stats.citation_metrics.ADSCitations": [[1, 1, 1, "", "aggregate_citations"], [1, 1, 1, "", "get_citations"], [1, 1, 1, "", "process_citations"]], "repo_stats.git_metrics": [[1, 0, 1, "", "GitMetrics"]], "repo_stats.git_metrics.GitMetrics": [[1, 1, 1, "", "get_age"], [1, 1, 1, "", "get_commits"], [1, 1, 1, "", "get_commits_via_git_log"], [1, 1, 1, "", "get_issues_PRs"], [1, 1, 1, "", "parse_log_line"], [1, 1, 1, "", "process_commits"], [1, 1, 1, "", "process_issues_PRs"]], "repo_stats.plot": [[1, 2, 1, "", "author_time_plot"], [1, 2, 1, "", "citation_plot"], [1, 2, 1, "", "issue_PR_time_plot"], [1, 2, 1, "", "open_issue_PR_plot"]], "repo_stats.runner": [[1, 2, 1, "", "main"], [1, 2, 1, "", "parse_parameters"]], "repo_stats.user_stats": [[1, 0, 1, "", "StatsImage"]], "repo_stats.user_stats.StatsImage": [[1, 1, 1, "", "draw_text"], [1, 1, 1, "", "update_image"]], "repo_stats.utilities": [[1, 2, 1, "", "fill_missed_months"], [1, 2, 1, "", "rolling_average"], [1, 2, 1, "", "update_cache"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"": 1, "0": 1, "01": 1, "1": 1, "2013a": 1, "2024": 1, "33a": 1, "558a": 1, "7": 1, "90": 1, "A": 1, "For": 1, "One": 1, "The": 1, "across": 1, "ad": 1, "addit": 1, "adscit": 1, "ag": 1, "age_rec": 1, "age_recent_commit": 1, "aggreg": 1, "aggregate_cit": 1, "all": 1, "all_cit": 1, "all_item": 1, "all_stat": 1, "an": 1, "analysi": 1, "api": 0, "arg": 1, "argument": 1, "arrai": 1, "ascii": 1, "assum": 1, "author": 1, "author_time_plot": 1, "authors_per_month": 1, "averag": 1, "b2b2b2": 1, "bar": 1, "befor": 1, "being": 1, "below": 1, "bib": 1, "bibcod": 1, "break": 1, "cach": 1, "cache_dir": 1, "cache_fil": 1, "categor": 1, "chart": 1, "citat": 1, "citation_plot": 1, "cite": 1, "cite_al": 1, "cite_bibcod": 1, "cite_month": 1, "cite_per_year": 1, "cite_stat": 1, "cite_year": 1, "class": 1, "close": 1, "close_per_month": 1, "color": 1, "combin": 1, "command": 1, "commit": 1, "commit_stat": 1, "compon": 1, "contributor": 1, "conveni": 1, "coord": 1, "coordin": 1, "copi": 1, "correspond": 1, "count": 1, "current": 1, "dai": 1, "data": 1, "databas": 1, "date": 1, "datetim": 1, "days_sinc": 1, "decreas": 1, "default": 1, "dict": 1, "dictionari": 1, "directori": 1, "displai": 1, "doc": 0, "draw": 1, "draw_text": 1, "drawn": 1, "e": 1, "each": 1, "enforc": 1, "entri": 1, "exist": 1, "ff5804": 1, "fig": 1, "figur": 1, "file": 1, "fill": 1, "fill_missed_month": 1, "first": 1, "font": 1, "format": 1, "from": 1, "g": 1, "gener": 1, "get": 1, "get_ag": 1, "get_cit": 1, "get_commit": 1, "get_commits_via_git_log": 1, "get_issues_pr": 1, "git": 1, "github": [0, 1], "gitmetr": 1, "given": 1, "graphql": 1, "hash": 1, "histori": 1, "i": 1, "identifi": 1, "imag": 1, "imagedraw": 1, "imagefont": 1, "img": 1, "includ": 1, "index": [0, 1], "indic": 1, "individu": 1, "input": 1, "insert": 1, "instanc": 1, "int": 1, "issu": 1, "issue_pr_stat": 1, "issue_pr_time_plot": 1, "issues_pr": 1, "item": 1, "item_typ": 1, "its": 1, "json": 1, "kwarg": 1, "label": 1, "label_open": 1, "legend": 1, "length": 1, "line": 1, "list": 1, "local": 1, "locat": 1, "log": 1, "main": 1, "make": 1, "metric": 1, "miss": 1, "month": 1, "multi_authors_per_month": 1, "n_recent_author": 1, "name": 1, "nasa": 1, "new": 1, "new_author": 1, "new_authors_per_month": 1, "new_item": 1, "none": 1, "np": 1, "number": 1, "obtain": 1, "odd": 1, "old_item": 1, "one": 1, "open": 1, "open_issue_pr_plot": 1, "open_per_month": 1, "option": 1, "organ": 1, "output": 1, "over": 1, "owner": 1, "paper": 1, "param": 1, "paramet": 1, "pars": 1, "parse_log_lin": 1, "parse_paramet": 1, "part": 1, "path": 1, "per": 1, "pil": 1, "plt": 1, "popul": 1, "potenti": 1, "present": 1, "previou": 1, "process": 1, "process_cit": 1, "process_commit": 1, "process_issues_pr": 1, "provid": 1, "pub": 1, "pubdat": 1, "pull": 1, "pullrequest": 1, "quer": 1, "queri": 1, "read": 1, "readm": 1, "recent": 1, "recent_clos": 1, "recent_open": 1, "refer": 1, "referenc": 1, "repo": 0, "repo_local_path": 1, "repo_nam": 1, "repo_own": 1, "repo_stat": 0, "repositori": 1, "request": 1, "respositori": 1, "result": 1, "return": 1, "return_count": 1, "roll": 1, "roll_avg": 1, "rolling_averag": 1, "run": 1, "savenam": 1, "see": 1, "self": 1, "separ": 1, "set": 1, "simul": 1, "slide": 1, "sourc": 1, "stat": 1, "statist": 1, "statsimag": 1, "str": 1, "string": 1, "summar": 1, "target": 1, "templat": 1, "template_imag": 1, "text": 1, "text_color": 1, "tff": 1, "thi": 1, "those": 1, "time": 1, "timedelta": 1, "titl": 1, "token": 1, "total": 1, "true": 1, "tupl": 1, "type": 1, "unaverag": 1, "uniqu": 1, "unique_author": 1, "unique_output": 1, "updat": 1, "update_cach": 1, "update_imag": 1, "us": 1, "welcom": 0, "where": 1, "which": 1, "width": 1, "window": 1, "window_avg": 1, "wrapper": 1, "x": 1, "y": 1, "year": 1}, "titles": ["Documentation", "repo_stats API"], "titleterms": {"api": 1, "citation_metr": 1, "document": 0, "git_metr": 1, "plot": 1, "refer": 0, "repo_stat": 1, "runner": 1, "user_stat": 1, "util": 1}}) \ No newline at end of file