Data

Tools

Indexes

Applications

Experiments

Open Source Science

python-ta

Adventures in code analysis for teaching Python.

https://github.com/pyta-uoft/pyta

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    18 of 44 committers (40.9%) from academic institutions
  • ✓
    Institutional organization owner
    Organization pyta-uoft has institutional domain (www.cs.toronto.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Adventures in code analysis for teaching Python.

Basic Info
Statistics
  • Stars: 98
  • Watchers: 7
  • Forks: 69
  • Open Issues: 8
  • Releases: 29
Created about 10 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

PyTA

PyTA is a Python program which uses static code analysis to help students find and fix common coding errors in introductory Python courses. Python already has great static analysis tools like pep8 and pylint, but these tools do not necessarily have the most beginner-friendly format. PyTA has two central goals:

  1. Statically identify common coding errors by using existing linting tools and building custom linters (e.g., as pylint checkers).
  2. Present beautiful, intuitive messages to students that are both helpful for fixing errors, and good preparation for the terser messages they will see in their careers.

This is a new project started in the Summer of 2016, and takes the form of a wrapper around pylint (with custom checkers) that operates directly on Python modules, as well as a website with some supplementary material going into further detail for the emitted errors.

For greater details on the errors PyTA checks for: Help Documentation.

For help getting started using PyTA: Quick Start.

Installation

If you're interested in using PyTA, you can install it using pip (or pip3, on OSX/Linux):

```console

pip install python-ta ```

Development

If you're developing PyTA:

  1. First, clone this repository.
  2. Open a terminal in this repo, and run pip install -e ".[dev, cfg, z3]" to install the dependencies.
  3. Then run pre-commit install to install the pre-commit hooks (for automatically formatting and checking your code on each commit).

While not strictly necessary for debugging, some debugging tools require graphviz to be installed on your system.

Tests

To run the test suite, run the following command from inside the pyta directory:

```console

python -m pytest tests # Or python3 on OSX/Linux ```

Generating the docs

The PyTA documentation is generated using Sphinx. To generate the documentation locally, run the commands:

```console

cd docs make html ```

Then open the file docs/_build/html/index.html in your web browser!

Demo

You can currently see a proof of concept in this repository. Clone it, and then run python in this directory (PyTA is primarily meant to be included as a library). In the Python interpreter, try running:

```python

import pythonta pythonta.checkall('examples.customcheckers.e9999forbiddenimport') [Some output should be shown] python_ta.doc('E9999') ```

Contributors

Ibrahim Bilal, Lorena Buciu, Simon Chen, Freeman Cheng, Ivan Chepelev, Yianni Culmone, Daniel Dervishi, Nigel Fong, Adam Gleizer, James Han, Ibrahim Hasan, Niayesh Ilkhani, Craig Katsube, Rebecca Kay, Christopher Koehler, David Kim, Simeon Krastnikov, Ryan Lee, Christopher Li, Hoi Ching (Herena) Li, Hayley Lin, Bruce Liu, Merrick Liu, Wendy Liu, Yibing (Amy) Lu, Maria Shurui Ma, Aina Fatema Asim Merchant, Karl-Alexandre Michaud, Shweta Mogalapalli, Ignas Panero Armoska, Justin Park, Harshkumar Patel, Varun Sahni, Eleonora Scognamiglio, Stephen Scott, Amr Sharaf, Richard Shi, Kavin Singh, Alexey Strokach, Sophy Sun, Ali Towaiji, Utku Egemen Umut, Sarah Wang, Lana Wehbeh, Jasmine Wu, Raine Yang, Philippe Yu, Yi Cheng (Michael) Zhao

Owner

  • Name: PyTA
  • Login: pyta-uoft
  • Kind: organization

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: PythonTA
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: David
    family-names: Liu
    email: david@cs.toronto.edu
    affiliation: University of Toronto
    orcid: "https://orcid.org/0000-0001-5777-5833"
repository-code: "https://github.com/pyta-uoft/pyta"
url: "https://www.cs.toronto.edu/~david/pyta/"
abstract: Code checking tool for teaching Python.
license: GPL-3.0
commit: 23cd60ce7bad47a5edffed7c7e2bed7d3e4da46a
version: 2.6.1
date-released: "2023-08-13"

GitHub Events

Total
  • Fork event: 11
  • Create event: 21
  • Commit comment event: 1
  • Release event: 4
  • Issues event: 16
  • Watch event: 9
  • Delete event: 16
  • Issue comment event: 163
  • Push event: 99
  • Gollum event: 1
  • Pull request review comment event: 335
  • Pull request review event: 217
  • Pull request event: 205
Last Year
  • Fork event: 11
  • Create event: 21
  • Commit comment event: 1
  • Release event: 4
  • Issues event: 16
  • Watch event: 9
  • Delete event: 16
  • Issue comment event: 163
  • Push event: 99
  • Gollum event: 1
  • Pull request review comment event: 335
  • Pull request review event: 217
  • Pull request event: 205

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,889
  • Total Committers: 44
  • Avg Commits per committer: 42.932
  • Development Distribution Score (DDS): 0.683
Top Committers
Name Email Commits
RyanDJLee r****e@m****a 598
David Liu d****d@c****u 299
Nigel Fong n****g@m****a 197
Justin J****5@g****m 101
Simeon Krastnikov s****v@m****a 83
Shweta Mogalapalli s****i@m****a 67
Niayesh Ilkhani n****i@m****a 57
hayleyZHL h****o@g****m 57
ostrokach o****h@g****m 54
JiaXin j****u@m****a 48
Wendy y****u@m****a 47
Chris K c****r@m****a 34
Rebecca Kay r****y@m****a 31
Amr Sharaf a****f@g****m 21
kavins14 k****h@m****a 21
Lorena B 4****b@u****m 17
Craig Katsube c****e@m****a 15
David Lim d****3@g****m 12
pre-commit-ci[bot] 6****]@u****m 10
Yibing (Amy) Lu 5****u@u****m 10
Sophy Sun s****n@m****a 9
Simon Chen s****n@m****a 9
Ibrahim Hasan i****n@m****a 9
Freeman Cheng c****2@g****m 9
KnightLatreia 1****e@u****m 7
david-yz-liu l****d@c****u 7
Harshkumar Patel 6****l@u****m 7
David Hyun Suk Lim 3****m@u****m 6
Younwoo (Ethan) Choi y****i@m****a 6
kavins14 k****h@h****m 5
and 14 more...
Committer Domains (Top 20 + Academic)
mail.utoronto.ca: 16 cs.toronto.edu: 2 wumbo.ca: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 36
  • Total pull requests: 510
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 10 days
  • Total issue authors: 21
  • Total pull request authors: 35
  • Average comments per issue: 0.61
  • Average comments per pull request: 1.15
  • Merged pull requests: 418
  • Bot issues: 1
  • Bot pull requests: 69
Past Year
  • Issues: 4
  • Pull requests: 194
  • Average time to close issues: 4 months
  • Average time to close pull requests: 5 days
  • Issue authors: 4
  • Pull request authors: 13
  • Average comments per issue: 0.75
  • Average comments per pull request: 1.36
  • Merged pull requests: 154
  • Bot issues: 0
  • Bot pull requests: 29
View more stats
Top Authors
Issue Authors
  • david-yz-liu (4)
  • ChristopherLi05 (4)
  • Raine-Yang-UofT (4)
  • ch-iv (3)
  • quiz3 (3)
  • klokailo (3)
  • matin1099 (1)
  • paulschreiber (1)
  • TheGreatCorrine (1)
  • Raiden-Makoto (1)
  • Jasminewwwu (1)
  • leowrites (1)
  • dependabot[bot] (1)
  • amanjitsk (1)
  • jcal13 (1)
Pull Request Authors
  • david-yz-liu (118)
  • dependabot[bot] (62)
  • Raine-Yang-UofT (44)
  • CulmoneY (35)
  • sushimon (26)
  • Karl-Michaud (24)
  • quiz3 (22)
  • pre-commit-ci[bot] (17)
  • lxyhan (17)
  • michaelZhaoCode (16)
  • elescogna (14)
  • herenali (13)
  • umututku03 (12)
  • Bruce-8 (12)
  • MariaMa-GitHub (12)
Top Labels
Issue Labels
dependencies (1) github_actions (1)
Pull Request Labels
dependencies (62) github_actions (26) python (14)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 2,157 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 45
    (may contain duplicates)
  • Total versions: 91
  • Total maintainers: 1
proxy.golang.org: github.com/pyta-uoft/pyta
  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
pypi.org: python-ta

Code checking tool for teaching Python

  • Versions: 64
  • Dependent Packages: 0
  • Dependent Repositories: 45
  • Downloads: 2,157 Last month
Rankings
Dependent repos count: 2.2%
Forks count: 5.8%
Average: 6.7%
Stargazers count: 7.7%
Downloads: 7.9%
Dependent packages count: 10.1%
Maintainers (1)
david-yz-liu
Last synced: 6 months ago

Dependencies

.github/workflows/test.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite