How to run a Python package with one command line

Question

I'm a newbie in Python. And I don't know how to run a python package with only one command line. I have been searched it on GG but I have no key-word. There is my folder:

├── config.json
└── my_source
    ├──__init__.py
    ├──filter.py
    └──get_new_users.py

And config.json contains 3 parameters and able change by the user. So, I want to run this my_source package with one command line like this:

my_source -c config.json

Could I able to run my code in this way? If it's possible. Could anyone give me a key-word or a way to do it? If you need more info, please leave a comment. Thank you.

you mean execute the script? – Kunal Mukherjee Nov 23 '18 at 08:16 — Kunal Mukherjee, Nov 23 '18 at 08:16
you are right. @KunalMukherjee – Han Van Pham Nov 23 '18 at 09:31 — Han Van Pham, Nov 23 '18 at 09:31

Kunal Mukherjee · Answer 1 · 2019-07-12T05:25:10.353

31

To run a python module/package specify the -m flag.

For example in your situation it will be something like:

python -m my_course.filter

See this SO question for more info.

edited Jul 12 '19 at 05:25

answered Nov 23 '18 at 10:44

Kunal Mukherjee

5,775
3
25
53

1

I think this is the best answer for how the OPs question is phrased. Exactly what I was looking for. – SocraticDatum Jan 23 '20 at 20:07

score 3 · Accepted Answer · answered Nov 23 '18 at 08:16

3

It's not clear what you mean "run a folder". Rather you can import the folder as a module, in other code, say app.py

├── config.json
├── app.py
└── my_source
    ├──__init__.py
    ├──filter.py
    └──get_new_users.py

And do from my_source import * within app.py to use the function/variables defined there

Then, run python app.py, and pass config.json somehow depending on the internals of that code

answered Nov 23 '18 at 08:16

OneCricketeer

179,855
19
132
245

1

Thank you. In case if I want to make it as a package. How can I run it? – Han Van Pham Nov 23 '18 at 08:36
1

Perhaps you can check some documentation about packages? https://docs.python.org/3/tutorial/modules.html#packages – OneCricketeer Nov 23 '18 at 16:18

How to run a Python package with one command line

2 Answers2