snu-quiqcl / qiwis

QuIqcl Widget Integration Software
MIT License
5 stars 2 forks source link

[FEATURE] Add more information to setup.py #145

Closed BECATRUE closed 1 year ago

BECATRUE commented 1 year ago

Feature you want to implement

To release our project, we need to add more information for users (may be us). The setup.py of ARTIQ is a good example!

How the feature is implemented

We can add the develop information, license, etc., but I think _consolescripts is the most significant property. It can make us run swift not using python -m swift.swift but just swift (the command name is an example).

kangz12345 commented 1 year ago

😮 looks cool!

BECATRUE commented 1 year ago

Since we can add various arguments in setup.py, I want to be comfirmed first. For details, see setup docs.

And also, I want to add console script as follows:

python -m swift.swift -s $(setup_path)
swift -s $(setup_path)  // the same result
BECATRUE commented 1 year ago

Please leave your opinions! @kangz12345

kangz12345 commented 1 year ago

You can use my e-mail address: kangz12345@snu.ac.kr url: this GitHub page would be good enough. package: it excludes the examples, tests, etc., right?

BECATRUE commented 1 year ago

You can use my e-mail address: kangz12345@snu.ac.kr url: this GitHub page would be good enough. package: it excludes the examples, tests, etc., right?

In terms of package, you are right! It includes only swift directory, not github root directory.