Add the ability to run the script from anywhere #112
Conversation
- Closes #111 - Added a MANIFEST.in file that will include our data files upon a distribution - Modify setup.py to include files required by MANIFEST.in
- Hopefully this will actually allow for us to distribute the package and have someone use it
- Created a symbolic link that will allow us to run the script from the command line (at least on Linux)
- The main parser will now output the absolute path to the HTML files to allow the user to output their HTML anywhere - Update the setup.py to require python 3.6
- Add an argument to the parser that will output the HTML that can be used for a standalone distribution
- The symlink version of this file does not work if the default python3 on a user's system is not 3.6. This change will allow it to work, but means that the command will take slightly longer to run. There's probably a better way to do this
|
There should be a better way of finding the install directory in youclidparser |
| @@ -0,0 +1 @@ | |||
| recursive-include youclidbackend/data/ * | |||
There was a problem hiding this comment.
MANIFEST.in is used for sdist (source distribution). This will include the necessary data files. To be honest, I don't quite know if this file is required, since we have package_data in the setup.py file. If it's not, we can remove this at a later date.
| @@ -3,6 +3,13 @@ | |||
|
|
|||
| setup(name='youclid', | |||
| version='0.1', | |||
| python_requires='>=3.6', | |||
There was a problem hiding this comment.
We use things that require python3.6, so we may as well ensure that the user has it when trying to install
| 'data/default.css', | ||
| 'data/draw.js', | ||
| 'data/index.js']}, | ||
| include_package_data=True, |
There was a problem hiding this comment.
The package_data will ship our relevant files with the install. The key is the package where the data files live. Note that this means these files MUST exist inside our pacakge (hence the symlinks to the files in the frontend).
setup.py
Outdated
| 'data/draw.js', | ||
| 'data/index.js']}, | ||
| include_package_data=True, | ||
| scripts=['bin/youclidparser'] |
There was a problem hiding this comment.
This will add our youclidparser command to $PATH, allowing the user to run it
bin/youclidparser
Outdated
| @@ -0,0 +1,4 @@ | |||
| #!/usr/bin/sh | |||
There was a problem hiding this comment.
This isn't the cleanest, but it means that no matter what version of python the user has as their default python3, python3.6 will be run. There's probably a better way to do this where we could just have this file symlink to main_parser.py (maybe #!python3.6 at the top of main_parser.py will force python3.6 to run?)
| @@ -5,6 +5,14 @@ | |||
| ### Dependencies | |||
| - python3.6 | |||
|
|
|||
| ### Installation | |||
| ```bash | |||
| pip3 install git+git://github.com/YouClid/youclid.git@master#egg=youclid | |||
There was a problem hiding this comment.
If you try this now, it won't work, since this PR isn't merged into master yet. What you'd want is
pip3 install git+git://github.com/YouClid/youclid.git@feature/script-from-anywhere#egg=youclid
|
I think we also want to be able to just give a directory full of yc files and it just parses all of them. Or maybe you could do something like |
|
Also a small nitpick, is there a reason you went with The former seems more verbose and unless we're going to have something different for |
|
@DrewMonroe we probably need to update the readme too right? |
|
Yeah, you're right, good call. I can do that right now. |
- This will fix issues discussed in #112
youclidparser) that will run the parser straight from the commandline