Commit Graph

82 Commits

Author SHA1 Message Date
Chris Lane
f692c8e1d8 Addressing cross-platform installation issues
Attempted to address various cross-platform installation issues:

- Removed all hard-coded references to file-paths, and replaced them
  with paths provided by `appdirs`.

- Removed (erroneously inserted) default file paths which would never be
  checked due to application logic.

- Modified `setup.py` to no longer install a configuration file. The
  mechanics are still in place to **read** a configuration file, but
  after examination, I've concluded that the installation of that file
  is best left to package maintainers rather than `cheat` itself.
2019-02-09 13:27:58 -05:00
Chris Lane
89bb9aaf13 Included appdirs in project
The prior attempt to resolve #420 and #431 relied on `appdirs` to
determine the appropriate directories into which to install files.
Previously, `setup.py` dynamically attempted to install `appdirs` via
`pip` during installation if necessary.

This attempt to failed on multiple platforms, however, due to
backwards-incompatible `pip` interfaces.

As a workaround, I have now directly included `appdirs` (a small module)
within `cheat` itself. This approach is explicitly supported per the
`appdirs` documentation:

https://pypi.org/project/appdirs/
2019-02-08 11:21:09 -05:00
Chris Lane
482161f8e9 Installation issues
Resolves the following:

- #351 (use of `sudo` when installing)
- #420 (failure to install on Windows)
- #431 (failure to install on MacOS)

Application now relies on `appdirs` module to identify the appropriate
locations for storing configuration and data, both during installation
and runtime.
2019-02-07 13:34:20 -05:00
Chris Lane
074dba6e99 v2.5.0
`minor` version bump to `2.5.0`.
2019-02-04 12:04:52 -05:00
Chris Lane
9931b78c5f Lint
- Added instruction to lint `setup.py` to `ci/lint.sh`
- Updated `setup.py` per linter suggestions
2019-02-01 15:24:04 -05:00
Chris Lane
c922ef4c8d Version bump: 2.4.2
Contains `termcolor` dependency fix.
2019-01-29 11:45:43 -05:00
Chris Lane
5ae49228b7 Added termcolor dependency to setup.py
Added a missing `termcolor` dependency to `install_requires` in
`setup.py`. `termcolors` was introduced as an optional dependency when
the `CHEAT_HIGHLIGHT` envvar was implemented.
2019-01-29 11:42:14 -05:00
Chris Lane
9ea60d12ff Version-bump to 2.4.1
- Includes various bugfixes regarding UTF-8 encoding
- Adds new cheatsheets
2019-01-29 10:58:57 -05:00
Chris Allen Lane
5e1d3abce8
Merge pull request #416 from chrisallenlane/issue-414-build-opts
Issue #414 - snap package compatibility
2019-01-29 10:18:55 -05:00
Chris Lane
1b6b5b79b7 Version bump: 2.4.0
Preparing a new `minor` release.
2019-01-27 14:36:57 -05:00
Chris Lane
e319332138 Issue #414 - snap package compatibility
PR #391 changed the locaton into which system-wide cheatsheets are
installed to `/usr/share/cheat`, in order to comply with FHS. However,
this is causing conflicts with the `snap` packaging process.

This commit removes hard-coded references to `/usr/share/cheat` (outside
of `config/cheat`), and instead reads the cheat path via the
`CHEAT_PATH` config value (which may be set either in `cheat/config`, or
exported as an environment variable).

Lastly, this commit makes `setup.py` "aware of" the `CHEAT_PATH` env
var, allowing us to specify to where sytem-wide cheatsheets should be
installed during the `snap` build.
2019-01-21 12:58:03 -05:00
Tomas Korbar
a651426075 Add reading settings from configuration file 2019-01-15 17:09:35 +01:00
Tomas Korbar
c4c935a6a5 Change default location of cheatsheets 2019-01-15 16:48:07 +01:00
Chris Lane
cccf37c284 Bumped the patch version number 2018-10-16 10:45:09 -04:00
Chris Lane
8ec51d3194 v2.3.0
Version-bump to `v2.3.0`.
2018-10-15 10:51:11 -04:00
Chris Lane
aa1e12625e Version bump to 2.2.3. 2017-12-19 12:42:07 -05:00
Chris Lane
d7272c50c4 v2.2.2
Added new cheatsheets.
2017-09-16 23:15:15 -04:00
Chris Lane
d6dc39c687 v2.2.1
Version bump to 2.2.1. (Release contains new default cheatsheets.)
2017-09-05 14:23:10 -04:00
Chris Lane
edd7b5e806 Minor revisions on #244
- When using GFM code fences, strip the last line in addition to the
  first
- Updated `README.md` to mention the new feature
- `minor` version-bump to `2.2.0`.
2017-02-28 18:59:27 -05:00
Chris Lane
068d117bef patch version bump. 2017-02-27 23:02:23 -05:00
Chris Lane
8cad76943a v2.1.27
`patch` version bump.
2016-11-27 11:10:05 -05:00
Chris Lane
eff042d50b patch version bump 2016-08-05 15:18:52 -04:00
Chris Lane
3be95142ed v2.1.25 2016-05-29 21:47:22 -04:00
Chris Lane
20d985d993 Working around failed upload
pypi responded with an HTTP 500 when uploading the last version of
`cheat`, and this seems to have caused some problems. No changes were
made in this commit other than incrementing the version number in an
attempt to resolve this.
2016-03-24 12:41:40 -04:00
Chris Lane
09f821835c v2.1.23 2016-03-24 12:39:20 -04:00
Chris Lane
a063c7bb64 Licensing
Dual-licensed `cheat` under both the GPL3 and MIT licenses.
2016-02-15 17:13:20 -05:00
Chris Lane
d058ee087e Patch version bump. 2016-02-15 13:22:01 -05:00
Chris Lane
f9e8e041ef patch version bump. 2016-01-04 21:50:40 -05:00
Chris Lane
b6137cac8b patch version bump 2015-11-22 11:28:32 -05:00
Chris Lane
6a2eda80d4 patch version bump. 2015-10-15 18:57:33 -04:00
Chris Lane
20d52376f9 Undid packaging refactoring. 2015-10-15 18:56:34 -04:00
Chris Lane
3b2848668a patch version bump. 2015-10-15 18:40:18 -04:00
Chris Lane
a8f91d4224 Minor tweaks. 2015-10-15 18:37:02 -04:00
Chris Lane
e0adbbc5b9 Merge branch 'setup-improvements' of https://github.com/youtux/cheat into youtux-setup-improvements
* 'setup-improvements' of https://github.com/youtux/cheat:
  Use entry_points instead of scripts in setup.py
  Improve setup.py description
  Exploit setuptools package_data to include cheats
  Use find_packages from setuptools to identify packages
  Use setuptools insted of distutils.
2015-10-15 18:33:02 -04:00
Chris Lane
905f12a279 Patch version bump. 2015-10-15 18:30:25 -04:00
Chris Lane
cafa2fb2fd Version 2.1.15
Added new cheatsheets.
2015-09-09 18:06:23 -04:00
Chris Lane
2d7fdb5425 Patch version bump 2015-08-25 19:10:28 -04:00
Chris Lane
8096ca7f90 Version bump
2.1.13
2015-08-06 21:15:26 -04:00
Chris Lane
9c696cc430 v2.1.12 2015-08-04 20:56:23 -04:00
Chris Lane
6b736083c3 v2.1.11
- Merged PR #227

- Patch version bump
2015-07-31 15:19:22 -04:00
Chris Lane
74dfd51601 Version bump 2015-07-09 18:42:00 -04:00
Chris Lane
8a07a1e96c Version bump 2015-06-18 18:30:06 -04:00
Chris Lane
417f47f037 Version bump 2015-04-15 16:43:47 -04:00
Chris Lane
e9b8f04c24 Bug fix
A bug was introduced in 2.1.6 that would prevent user-defined
cheatsheets from being edited more than once.
2015-02-11 21:45:32 -05:00
Chris Lane
c70dc002fa Issue #180
Now, whenever a cheatsheet is to be edited, if that cheatsheet does not
exist on the `DEFAULT_SHEET_PATH`, it is first copied there before being
opened for editing. This prevents system-wide cheatsheets from being
edited when using `cheat` as `root`.
2015-02-11 21:02:45 -05:00
Chris Lane
718ec4f685 Resolves #207
- Solves issue whereby global cheatsheets fail to save after editing

- `cheat` no longer asks a user if a global cheatsheet should be copied
  locally before editing, and instead just silently does so.
2015-02-10 19:35:14 -05:00
Chris Lane
3d8343a878 Version bump 2015-02-09 18:10:08 -05:00
Alessio Bogon
4d57f529c9 Use entry_points instead of scripts in setup.py
This allows a fine-grained control of the dependencies, because it generates a wrapper script
that calls the specifiend function (i.e., main inside cheat/app.py)
2015-01-09 00:36:49 +01:00
Alessio Bogon
5caa8fed38 Improve setup.py description 2015-01-09 00:22:57 +01:00
Alessio Bogon
69f91e0cf4 Exploit setuptools package_data to include cheats 2015-01-09 00:08:38 +01:00