statsmodels / statsmodels/statsmodels

add api.py to all subdirectories

Open
#251 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design
Dominant language
Python
Stars
11.6k
Forks
3.6k
Avg merge
7h 37m
Merged PRs (30d)
96

Description

see https://groups.google.com/group/pystatsmodels/browse_thread/thread/9cdfd56fd659659a?hl=en

I think it will be possible to do it in 0.4.1 without breaking backwards compatibility if we don't remove imports from the __init__.py

Remove all imports from __init__.py for release 0.5.0

I haven't looked at subdirectories at lower levels, eg. genmod.families which doesn't have code that isn't needed by GLM. An api.py is really not necessary in this case, unless we add generic functions in there (e.g. pre-specified transformation that I want also for other models and methods)

One other exception, directories for only internal use have an empty __init__.py already, e.g.

statsmodels\base has only the test runner in the __init__.py
statsmodels\tsa\base completely empty
statsmodels\compatnp completely empty

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Google Groups discussion and inventory statsmodels subdirectories plus each init.py, including statsmodels/base, statsmodels/tsa/base, and statsmodels/compatnp. Determine which packages need api.py and preserve the stated 0.4.1 compatibility before checking that 0.5.0 removes the relevant init.py imports.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, developer-experience
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.