Skip to content

v0.2.0

Choose a tag to compare

@earnestt1234 earnestt1234 released this 25 May 17:01
· 112 commits to master since this release

Improvements to the main seedir() algorithm

  • There is now a single function which generates folder structure strings for both real directories and seedir "fake" ones. The main algorithm is contained in the new folderstructure.py module, which is aided by folderstructurehelpers.py (this contains many functions that were previously in seedir.seedir and seedir.fakedir).
  • The code is now simpler and (hopefully) more readable than the previous version.
  • Some small changes to the functionality of fringe cases:
    • using depthlimit=0 with a beyond string now produces just the root folder (this was incorrect before)
    • with beyond='content', empty folders are only shown when the depthlimit is crossed
    • trailing separators or slashes no longer cause the name of the root folder to be empty

Added more test cases

  • More unittests have been added to seedir/tests/tests.py.

Overhaul documentation

  • The examples Jupyter notebook has been removed, in favor of a gettingstarted.md file which has been added to the main page of the API docs.
  • The getting started README as well as the seedir.fakedir module are now doctest-able.
  • New style added to the API docs.
  • seedir.seedir module has been renamed to seedir.realdir to avoid some of my confusions
  • added an exampledir to the docs folder for some examples

Other changes

  • name parameter added to seedir.fakedir.randomdir
  • some changes to seedir.fakedir.fakedir_fromstring to handle some more failed cases.
  • now convert some arguments to bool or int in the command line tool
  • words, FakeItem removed from package namespace