From 50a669842bccb2a61f24bb561520a9c3847630b7 Mon Sep 17 00:00:00 2001 From: Iskandar Sitdikov Date: Mon, 9 Aug 2021 16:54:15 -0700 Subject: [PATCH] Project: initial project setup (#3) * Project: initial project setup * Readme: fix * Readme: fix * Readme: fix --- .github/ISSUE_TEMPLATE/bug_report.md | 14 + .github/ISSUE_TEMPLATE/enhancement_request.md | 11 + .github/ISSUE_TEMPLATE/feature_request.md | 10 + .github/ISSUE_TEMPLATE/submission.yml | 80 +++ .github/PULL_REQUEST_TEMPLATE.m | 17 + .github/workflows/tests.yml | 45 ++ .gitignore | 2 +- .pylintrc | 623 ++++++++++++++++++ CODE_OF_CONDUCT.md | 9 + CONTRIBUTING.md | 6 + README.md | 58 +- docs/design-doc.md | 4 +- ecosystem/__init__.py | 0 ecosystem/utils.py | 6 + manager.py | 0 requirements-dev.txt | 3 + requirements.txt | 1 + setup.cfg | 2 + setup.py | 18 + tests/__init__.py | 0 tests/test_utils.py | 12 + tox.ini | 30 + 22 files changed, 947 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/submission.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.m create mode 100644 .github/workflows/tests.yml create mode 100644 .pylintrc create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 ecosystem/__init__.py create mode 100644 ecosystem/utils.py create mode 100644 manager.py create mode 100644 requirements-dev.txt create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/__init__.py create mode 100644 tests/test_utils.py create mode 100644 tox.ini diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..58ced71b40 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,14 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve 🤔. +labels: bug +--- + + + + +### Steps to reproduce the problem + +### What is the current behavior? + +### What is the expected behavior? diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md new file mode 100644 index 0000000000..e5bc9eeb3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -0,0 +1,11 @@ +--- +name: 💅 Enhancement request +about: Suggest an improvement for this project 🆒! +labels: 'type: enhancement' +--- + + + + +### What is the expected enhancement? + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..e1bf923c31 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,10 @@ +--- +name: 🚀 Feature request +about: Suggest an idea for this project 💡! +labels: 'type: feature request' +--- + + + + +### What is the expected behavior? diff --git a/.github/ISSUE_TEMPLATE/submission.yml b/.github/ISSUE_TEMPLATE/submission.yml new file mode 100644 index 0000000000..08be532ef4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/submission.yml @@ -0,0 +1,80 @@ +name: Project submission +description: Ecosystem project submission +title: "[Submission]: " +labels: [] +assignees: + - octocat +body: + - type: markdown + attributes: + value: | + Provide information about your project. + - type: input + id: repo + attributes: + label: Github repo + description: Link to your github repo with project you want to submit + placeholder: https://github.com/Qiskit/qiskit-terra + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Short description of the project. + placeholder: Tell us about your work! + value: "..." + validations: + required: true + - type: input + id: contacts + attributes: + label: Email + description: Your contact information + placeholder: awesome_person@awesome_main.com + validations: + required: false + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Short description of alternative projects. + placeholder: There are no alternatives to this project! + validations: + required: false + - type: dropdown + id: license + attributes: + label: License + description: License for your project + options: + - Apache License 2.0 + - MIT license + - BSD 3-Clause "New" or "Revised" license + - BSD 2-Clause "Simplified" or "FreeBSD" license + - GNU General Public License (GPL) + - GNU Library or "Lesser" General Public License (LGPL) + - Mozilla Public License 2.0 + - Common Development and Distribution License + - Eclipse Public License version 2.0 + validations: + required: true + - type: textarea + id: affiliations + attributes: + label: Affiliations + description: Affiliations of the project. + placeholder: None + validations: + required: false + - type: dropdown + id: tags + attributes: + label: Tags + multiple: true + options: + - tool + - plugin + - tutorial + - paper-implementation + - fork diff --git a/.github/PULL_REQUEST_TEMPLATE.m b/.github/PULL_REQUEST_TEMPLATE.m new file mode 100644 index 0000000000..eb743cc2e3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.m @@ -0,0 +1,17 @@ + + +### Summary + + + +### Details and comments diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000000..b7269fda42 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,45 @@ +name: Tests + +on: [push] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: '3.9' + - name: Install tox + run: | + python -m pip install --upgrade pip + pip install tox + - name: Run styles check + run: tox -elint + tests: + runs-on: ubuntu-latest + strategy: + max-parallel: 4 + matrix: + python-version: [3.9] + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Set up tox env + run: | + pver=${{ matrix.python-version }} + tox_env="-epy${pver/./}" + echo tox_env + echo TOX_ENV=$tox_env >> $GITHUB_ENV + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r requirements-dev.txt + - name: Test using tox envs + run: | + tox ${{ env.TOX_ENV }} diff --git a/.gitignore b/.gitignore index 1d4e7389d3..b97131ebb0 100644 --- a/.gitignore +++ b/.gitignore @@ -128,4 +128,4 @@ dmypy.json # Pyre type checker .pyre/ -.idea/ \ No newline at end of file +.idea/ diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000000..587616eac7 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,623 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths. +ignore-paths= + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Ignore function signatures when computing similarities. +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..f82b61c5f6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ + + +# Code of Conduct +All members of this project agree to adhere to the Qiskit Code of Conduct listed at [https://github.com/Qiskit/qiskit/blob/master/CODE_OF_CONDUCT.md](https://github.com/Qiskit/qiskit/blob/master/CODE_OF_CONDUCT.md) + +---- + +License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), +Copyright Contributors to Qiskit. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..3523313920 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +First read the overall project contributing guidelines. These are all +included in the qiskit documentation: + +https://qiskit.org/documentation/contributing_to_qiskit.html diff --git a/README.md b/README.md index e6a5378629..c710df7cb0 100644 --- a/README.md +++ b/README.md @@ -1 +1,57 @@ -# ecosystem \ No newline at end of file +# Ecosystem [![Tests](https://github.com/qiskit-community/ecosystem/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/qiskit-community/ecosystem/actions/workflows/tests.yml) + + +
+

+

+ + Qiskit + +

+

Ecosystem

+

+ + + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. Join the Ecosystem
    3. +
  3. Roadmap
    4. +
  4. License
    5. +
+
+ + + + +## About The Project + +The Ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers. +The goal of the Ecosystem is to recognize, support and accelerate development of quantum technologies using Qiskit. + + + +## [Join the Ecosystem](https://github.com/qiskit-community/ecosystem/issues/new?labels=&template=submission.yml&title=%5BSubmission%5D%3A+) + +To join the Ecosystem create a [submission issue](https://github.com/qiskit-community/ecosystem/issues/new?labels=&template=submission.yml&title=%5BSubmission%5D%3A+) + + + +## Roadmap + +See the [contributing](./CONTRIBUTING.md) document to learn about the source code contribution process developers follow. + +See the [code of conduct](./CODE_OF_CONDUCT.md) to learn about the social guidelines developers are expected to adhere to. + +See the [open issues](https://github.com/qiskit-community/ecosystem/issues) for a list of proposed features (and known issues). + + + + +## License + +Distributed under the Apache License. See [LICENSE.txt](./LICENSE) for more information. diff --git a/docs/design-doc.md b/docs/design-doc.md index 5303a916aa..0351de5bee 100644 --- a/docs/design-doc.md +++ b/docs/design-doc.md @@ -2,8 +2,8 @@ ## Introduction -The ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad set of community developers and researchers. -The goal of this ecosystem is to recognize, support and accelerate development of quantum technologies using Qiskit. +The Ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers. +The goal of the Ecosystem is to recognize, support and accelerate development of quantum technologies using Qiskit. ## System Design and Architecture diff --git a/ecosystem/__init__.py b/ecosystem/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/ecosystem/utils.py b/ecosystem/utils.py new file mode 100644 index 0000000000..8fada2ed73 --- /dev/null +++ b/ecosystem/utils.py @@ -0,0 +1,6 @@ +"""Utils functions for ecosystem management.""" + + +def demo(): + """Demo util.""" + return True diff --git a/manager.py b/manager.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000000..c8af9725b7 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,3 @@ +coverage==5.5 +pylint==2.9.5 +tox==3.24.0 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000..28996523d3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +fire==0.4.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000000..b88034e414 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..ebb3a2ec18 --- /dev/null +++ b/setup.py @@ -0,0 +1,18 @@ +"""Setup file for ecosystem.""" + +import setuptools + +with open("README.md", "r") as fh: + long_description = fh.read() + +with open('requirements.txt') as fp: + install_requires = fp.read() + +setuptools.setup( + name="ecosystem", + description="Ecosystem", + long_description=long_description, + packages=setuptools.find_packages(), + install_requires=install_requires, + python_requires='>=3.6' +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 0000000000..90ecfbb638 --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,12 @@ +"""Tests utils.""" +from unittest import TestCase + +from ecosystem.utils import demo + + +class TestUtils(TestCase): + """Tests utils.""" + + def test_demo(self): + """Tests demo function.""" + self.assertTrue(demo()) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..a8f0ebf5bb --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +[tox] +minversion = 3.6 +envlist = py36, py37, py38, py39, lint, coverage +skipsdist = True + +[testenv] +usedevelop = true +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} + LANGUAGE=en_US + LC_ALL=en_US.utf-8 +deps = -r requirements.txt + -r requirements-dev.txt +commands = + pip check + python -m unittest -v + +[testenv:lint] +sitepackages = False +commands = + pylint -rn ecosystem tests + +[testenv:coverage] +basepython = python3 +setenv = + {[testenv]setenv} + PYTHON=coverage3 run --source ecosystem --parallel-mode +commands = + coverage3 report --fail-under=80