Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaces tomato emoji with GitHub flavored markdown #1

Merged
merged 2 commits into from
Oct 11, 2021
Merged

Replaces tomato emoji with GitHub flavored markdown #1

merged 2 commits into from
Oct 11, 2021

Conversation

snehankekre
Copy link
Contributor

@snehankekre snehankekre commented Oct 8, 2021

The tomato emoji in the README breaks installation on Windows via setup.py:

with open("README.md", "r") as fh:
    long_description = fh.read()
PS C:\Users\sneha\Desktop> pip install plost --no-cache-dir
Collecting plost
  Downloading Plost-0.2.1.tar.gz (12 kB)
    ERROR: Command errored out with exit status 1:
     command: 'c:\users\sneha\appdata\local\programs\python\python38\python.exe' -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\sneha\\AppData\\Local\\Temp\\pip-install-6oqzx1bp\\plost_026235d7f64b4ef5854eed7dffc9ce84\\setup.py'"'"'; __file__='"'"'C:\\Users\\sneha\\AppData\\Local\\Temp\\pip-install-6oqzx1bp\\plost_026235d7f64b4ef5854eed7dffc9ce84\\setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base 'C:\Users\sneha\AppData\Local\Temp\pip-pip-egg-info-qt103lso'
         cwd: C:\Users\sneha\AppData\Local\Temp\pip-install-6oqzx1bp\plost_026235d7f64b4ef5854eed7dffc9ce84\
    Complete output (7 lines):
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "C:\Users\sneha\AppData\Local\Temp\pip-install-6oqzx1bp\plost_026235d7f64b4ef5854eed7dffc9ce84\setup.py", line 4, in <module>
        long_description = fh.read()
      File "c:\users\sneha\appdata\local\programs\python\python38\lib\encodings\cp1252.py", line 23, in decode
        return codecs.charmap_decode(input,self.errors,decoding_table)[0]
    UnicodeDecodeError: 'charmap' codec can't decode byte 0x8d in position 4: character maps to <undefined>

Replaces the emoji with GitHub flavored markdown :tomato: so that the emoji is correctly rendered on GitHub + the README is parsed on Windows.

The tomato emoji in the README breaks installation on Windows via setup.py:

```python
with open("README.md", "r") as fh:
    long_description = fh.read()
```

Replaces the emoji with [GitHub flavored markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#using-emoji) `:tomato:` so that the emoji is correctly rendered on GitHub +  the README is parsed on Windows.
Replaces tomato emoji with GitHub flavored markdown
@tvst tvst merged commit 51d2c39 into tvst:master Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants